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 10, 2023
1 parent 6a813c0 commit 705d48a
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 21 deletions.
27 changes: 19 additions & 8 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
## 预览

**整体效果**
**Overall**

![image](imgs/3.png)

Expand All @@ -31,29 +31,36 @@

**Styles Supported**

![image](imgs/7.png)

![image](imgs/5.png)

还包括 YAML Front Matter/ Math Script / TOC 等样式

![image](imgs/6.png)

## Features

- 支持英文和简体中文,正文字体中文使用[思源宋体](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)
- 支持英文和简体中文,正文字体中文使用[思源宋体](https://source.typekit.com/source-han-serif/cn/),英文使用[Cantarell](https://fonts.google.com/specimen/Cantarell);

代码字体使用 [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)

- 提供浅色和黑暗两种主题 - Lapis / Lapis Dark

- 结合 Markdown 的特性尽可能呈现简洁的界面和多样的层次, 还包括 Sidebar 等样式支持。

## 安装

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 的主题文件夹中。
3.`lapis.css` & `lapis-dark.css` 文件和 `lapis` 文件夹复制到 Typora 的主题文件夹中。
4. 重启 Typora,然后从主题列表中选择 “Lapis”。

## 贡献

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

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

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

## 致谢

Expand All @@ -64,3 +71,7 @@
## 许可

Lapis Typora 主题在 MIT License 下发布。你可以自由地使用、修改和分发这个主题。

---

如果喜欢这个主题,给它点一个 STAR 吧📘
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@
</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 theme for Typora, with English & 简体中文 supported.

Both light and dark themes are available, providing clean and rich Markdown styles.

## Preview

**Overall**
Expand All @@ -28,26 +22,30 @@ Both light and dark themes are available, providing clean and rich Markdown styl

**Styles Supported**

![image](imgs/7.png)

![image](imgs/5.png)

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

![image](imgs/6.png)

## Features

- 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/).
- Provides 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/).
- Both light and dark themes are available, with clean and rich Markdown styles.

## Installation

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.
3. Copy the `lapis.css` & `lapis-dark.css` files and the `lapis` folder into Typora's theme folder.
4. Restart Typora and select the `Lapis`/`Lapis Dark` theme from the theme menu.

## Contributing

As developed on a Linux platform, this theme may have some unexpected issues on other platforms.
As developed on a Linux platform, this theme may have some unexpected problems on other platforms.

If you have any issues or suggestions, welcome to submit [Issues](https://github.com/YiNNx/typora-theme-lapis/issues). For any style fixing or new feature, welcome to submit [Pull Requests](https://github.com/YiNNx/typora-theme-lapis/pulls). Thank you for your feedback and contributions!

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

---

If you like this theme, please give me a STAR :raised_hands:
If you like this theme, please give me a STAR 📘
Binary file modified 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 modified 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 modified 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 modified 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 modified 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 added imgs/6.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/7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion lapis.css
Original file line number Diff line number Diff line change
Expand Up @@ -596,6 +596,10 @@ pre.md-meta-block {
/* border-bottom: 1px solid var(--primary-color); */
}

pre.md-fences-advanced.md-focus .md-fences-adv-panel {
border-radius: .8rem;
}

/*
* Scrollbar
*/
Expand Down Expand Up @@ -642,7 +646,7 @@ pre.md-meta-block {
}

.md-fences .cm-s-inner.CodeMirror {
margin: 2rem 0;
margin: 1.5rem 0;
}

.cm-s-inner.CodeMirror {
Expand Down

0 comments on commit 705d48a

Please sign in to comment.