Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
YiNNx committed Jun 9, 2023
1 parent a4f17dd commit 6a813c0
Show file tree
Hide file tree
Showing 14 changed files with 44 additions and 38 deletions.
38 changes: 21 additions & 17 deletions README-CN.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<h1 align="center">Typora Theme - Lapis</h1>
<p align="center">🖊️ 一款以蓝色为主色调的 Typora 浅色主题</p>
<p align="center">🖊️ 一款以蓝色为主色调的 Typora 主题</p>
<div align="center">
<div>
<img src="imgs/preview5.png" width="40%" />
<img src="imgs/preview6.png" width="40%" />
<img src="imgs/2.png" width="40%" />
<img src="imgs/1.png" width="40%" />
</div>
</div>
<p align="center"><a href="https://github.com/YiNNx/typora-theme-lapis/blob/master/README.md">English</a> / 简体中文</p>
Expand All @@ -15,30 +15,34 @@

支持浅色主题和浅色代码块,结合 Markdown 的特性尽可能呈现简洁的界面和多样的层次。在自己使用的半年期间,又逐渐对各种排版细节进行调整,优化了长文章阅读和书写体验。目前中英文阅读书写体验都挺不错。

> 初始样式代码基于 [evgo2017](https://github.com/evgo2017)[typora-theme-orange-heart](https://github.com/evgo2017/typora-theme-orange-heart)
>
> 代码配色灵感来自 VSCode 主题 [Winter is Coming](https://vscodethemes.com/e/johnpapa.winteriscoming/winter-is-coming-light-no-italics)
> **UPDATE:** 新增了 Dark 版本
## 预览

整体效果![preview](imgs/preview1.png)
**整体效果**

![](https://cdn.just-plain.fun/img/preview3.png)
![image](imgs/3.png)

样式支持
<div align="center">Light</div>

![preview](imgs/preview2.png)
![image](imgs/4.png)

<div align="center">Dark</div>

**Styles Supported**

![image](imgs/5.png)


## Features

- 支持英文和简体中文,并优化了中英长文章阅读体验,正文字体中文使用[思源宋体](https://source.typekit.com/source-han-serif/cn/),英文使用[Cantarell](https://fonts.google.com/specimen/Cantarell)
- 结合 Markdown 的特性呈现简洁的界面和多样的层次。同时还包括 Sidebar 等样式支持。
- 浅色代码块主题,代码字体使用 [Jetbrains Mono](https://www.jetbrains.com/lp/mono/)配色灵感来自 VSCode Theme - [Winter is Coming](https://vscodethemes.com/e/johnpapa.winteriscoming/winter-is-coming-light-no-italics)
- 支持英文和简体中文,正文字体中文使用[思源宋体](https://source.typekit.com/source-han-serif/cn/),英文使用[Cantarell](https://fonts.google.com/specimen/Cantarell)
- 结合 Markdown 的特性呈现简洁的界面和多样的层次。还包括 Sidebar \ TOC \ Math Script \ YAML Front Matter 等样式支持。
- 代码字体使用 [Jetbrains Mono](https://www.jetbrains.com/lp/mono/)代码块配色灵感来自 VSCode Theme - [Winter is Coming](https://vscodethemes.com/e/johnpapa.winteriscoming/winter-is-coming-light-no-italics)

## 安装

1. Clone 此仓库,[下载 ZIP 文件](https://cdn.just-plain.fun/static/lapis_latest.zip) 并解压。
1. Clone 此仓库,或从 [Latest Release](https://github.com/YiNNx/typora-theme-lapis/releases/latest) 中下载`typora-theme-lapis.zip`并解压。
2. 在 Typora 菜单中选择 偏好设置 (Preferences) -> 找到外观部分,点击“打开主题文件夹”按钮。
3.`lapis.css` 文件和 `lapis` 文件夹复制到 Typora 的主题文件夹中。
4. 重启 Typora,然后从主题列表中选择 “Lapis”。
Expand All @@ -47,9 +51,9 @@

这款主题最初是在 Linux 版本下编写和使用,其他平台上有概率出现一些意想不到的问题;同时由于主题样式大部分是基于作者的日常使用而编写,可能会有许多未发现的样式 bug。

如果你遇到问题或有任何建议和想法,欢迎直接提交 [Issues](https://github.com/yinnx/typora-theme-lapis/issues)
如果你遇到问题或有任何建议, 想法或贡献,欢迎直接提交 [Issues](https://github.com/yinnx/typora-theme-lapis/issues) & [Pull Request](https://github.com/YiNNx/typora-theme-lapis/pulls).

任何样式的修复和新特性的增加,欢迎提交 [Pull Request](https://github.com/YiNNx/typora-theme-lapis/pulls)感谢你的反馈和贡献!
感谢你的反馈和贡献!

## 致谢

Expand All @@ -59,4 +63,4 @@

## 许可

Lapis Typora 主题在 [MIT License](https://chat.openai.com/c/LICENSE) 下发布。你可以自由地使用、修改和分发这个主题。
Lapis Typora 主题在 MIT License 下发布。你可以自由地使用、修改和分发这个主题。
42 changes: 22 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,49 @@
<h1 align="center">Typora Theme - Lapis</h1>
<p align="center">🖊️ A Refreshing Light Typora Theme in Blue Tones</p>
<p align="center">🖊️ A Typora Theme in Blue Tones</p>
<div align="center">
<div>
<img src="imgs/preview5.png" width="40%" />
<img src="imgs/preview6.png" width="40%" />
<img src="imgs/2.png" width="40%" />
<img src="imgs/1.png" width="40%" />
</div>
</div>
<p align="center">English / <a href="https://github.com/YiNNx/typora-theme-lapis/blob/master/README-CN.md">简体中文</a></p>

## Introduction

Lapis is a refreshing light theme for Typora, with English & [简体中文](https://github.com/YiNNx/typora-theme-lapis/blob/master/README-CN.md) supported.
Lapis is a theme for Typora, with English & 简体中文 supported.

> Lapis's style code is initially based on [evgo2017](https://github.com/evgo2017)'s [typora-theme-orange-heart](https://github.com/evgo2017/typora-theme-orange-heart).
>
> The code color scheme was inspired by the VSCode theme [Winter is Coming](https://vscodethemes.com/e/johnpapa.winteriscoming/winter-is-coming-light-no-italics).
Both light and dark themes are available, providing clean and rich Markdown styles.

## Preview

Overall
**Overall**

![](imgs/preview3.png)
![image](imgs/3.png)

![preview](imgs/preview1.png)
<div align="center">Light</div>

Styles Supported
![image](imgs/4.png)

![](imgs/preview4.png)
<div align="center">Dark</div>

**Styles Supported**

![image](imgs/5.png)

The theme also provides YAML Front Matter \ Math Script \ TOC styles.

## Features

- Supports English & [简体中文](https://github.com/YiNNx/typora-theme-lapis/blob/master/README-CN.md) with fonts [Cantarell](https://fonts.google.com/specimen/Cantarell) and [Source Han Serif](https://source.typekit.com/source-han-serif/cn/).
- Combines Markdown features to present a clean interface and a comfortable visual hierarchy.
- Provides a light code color scheme inspired by VSCode's [Winter is Coming](https://vscodethemes.com/e/johnpapa.winteriscoming/winter-is-coming-light-no-italics), with the font [Jetbrains Mono](https://www.jetbrains.com/lp/mono/).
- Supports English & 简体中文 with fonts [Cantarell](https://fonts.google.com/specimen/Cantarell) and [思源宋体](https://source.typekit.com/source-han-serif/cn/).
- Combines Markdown features to present a clean interface and a comfortable visual hierarchy.
- Provides light & dark code color schemes inspired by VSCode's [Winter is Coming](https://vscodethemes.com/e/johnpapa.winteriscoming/winter-is-coming-light-no-italics), with the font [Jetbrains Mono](https://www.jetbrains.com/lp/mono/).

## Installation

1. Clone this repository or download [the ZIP file](https://cdn.just-plain.fun/static/lapis_latest.zip).
1. Clone this repository or download from [Latest Release](https://github.com/YiNNx/typora-theme-lapis/releases/latest).
2. In Typora, open "Preferences" (`File` > `Preferences`). And then switch to the "Appearance" tab and click the "Open Theme Folder" button.
3. Copy the `lapis.css` file and the `lapis` folder into Typora's theme folder.
4. Restart Typora and select the `Lapis` theme from the theme menu.
4. Restart Typora and select the `Lapis`/`Lapis Dark` theme from the theme menu.

## Contributing

Expand All @@ -49,7 +53,7 @@ If you have any issues or suggestions, welcome to submit [Issues](https://github

## Credits

- The style code is initially based on [evgo2017](https://github.com/evgo2017)'s [typora-theme-orange-heart](https://github.com/evgo2017/typora-theme-orange-heart).
- The style code was initially based on [evgo2017](https://github.com/evgo2017)'s [typora-theme-orange-heart](https://github.com/evgo2017/typora-theme-orange-heart).

- The code color scheme was inspired by the VSCode theme [Winter is Coming](https://vscodethemes.com/e/johnpapa.winteriscoming/winter-is-coming-light-no-italics)

Expand All @@ -59,6 +63,4 @@ The Lapis Typora theme is released under the MIT License. You are free to use, m

---

Enjoy Markdown with Lapis 📘

If you like this theme, please give me a STAR :raised_hands:
Binary file added imgs/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed imgs/preview1.png
Binary file not shown.
Binary file removed imgs/preview2.png
Binary file not shown.
Binary file removed imgs/preview3.png
Binary file not shown.
Binary file removed imgs/preview4.png
Binary file not shown.
Binary file removed imgs/preview5.png
Binary file not shown.
Binary file removed imgs/preview6.png
Binary file not shown.
2 changes: 1 addition & 1 deletion lapis-dark.css
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
*/

#write span img {
filter: drop-shadow(var(--block-bg-color) 0px 0px 8px);
filter: drop-shadow(var(--block-bg-color) 0px 0px 8px) brightness(90%);
}

/*
Expand Down

0 comments on commit 6a813c0

Please sign in to comment.