Upload document

Author: Fentaniao

Demo.md

@@ -1,10 +1,10 @@
-# Demo of Liquid Theme
+# Demo for Liquid Theme
 
 [TOC]
 
 ## Preface
 
-1
+Open this demo with Typora in your local PC after you install Liquid Theme to check the render effect.
 
 ## Text
 

README.md

@@ -45,7 +45,7 @@ A nice theme for Typora, inspired by [Microsoft Fluent Design](https://www.micro
 
 ## Screenshots
 
-Liquid Theme aims to provide an excellent visual effect with Typora in Windows 11. I use the elements of modern UI such as Gradient, Mica, and Rounded Rectangle. This theme support both English and Chinese, provides 4 modes, Light Mode, Dark Mode, Ink Mode and Ink Dark Mode.
+Liquid Theme aims to provide an excellent visual effect with Typora in Windows 11. I use the elements of modern UI such as Gradient, Mica, and Rounded Rectangle. This theme support both English and Chinese, providing Light Mode, Dark Mode, Ink Mode and Ink Dark Mode.
 
 ![preview](./media/theme/liquid/preview.png)
 
@@ -65,7 +65,7 @@ Liquid Theme aims to provide an excellent visual effect with Typora in Windows 1
 
 ![dark-preview3](/media/theme/liquid/dark-preview3.png)
 
-### Ink Mode
+### Ink Mode & Ink Dark Mode
 
 Many people use the 2-in-1 PC such as Microsoft Surface, to study and write, or they are just in favor of handwritten fonts, then Ink Mode provides them with a chance to write and read in handwritten fonts in Typora.
 
@@ -77,20 +77,20 @@ Many people use the 2-in-1 PC such as Microsoft Surface, to study and write, or
 
 ## How to install
 
-1. Download the **Liquid.zip** from the [Releases](https://github.com/Fentaniao/Liquid/releases) in [Liquid repository](https://github.com/Fentaniao/Liquid/).
-2. Open Typora setting, in *Preferences*, click on *Appearance*, then on *Open Theme Folder*.
-3. Unzip **Liquid.zip** into the Theme Folder.
+1. Download the `Liquid.zip` from the [Releases](https://github.com/Fentaniao/Liquid/releases) in [Liquid repository](https://github.com/Fentaniao/Liquid/).
+2. Open Typora setting, in **Preferences**, click on **Appearance**, then on **Open Theme Folder**.
+3. Unzip `Liquid.zip` into the Theme Folder.
 4. Restart Typora.
-5. Select the Liquid themes from the *Themes* menu in Typora.
-6. Open Example.md to see local render effect.
+5. Select the Liquid themes from the **Themes** menu in Typora.
+6. Open `Demo.md` to see local render effect.
 
 ### Attention
 
 You need to install "liquid/FZSJ-SGLDXMHJW.TTF" font into your PC for rendering Chinese characters in Ink Mode.
 
-## Docs
+### Secondary Development Guidance
 
-Turn to [Secondary Development Guidance](https://github.com/Fentaniao/Liquid/blob/main/docs/SecondaryDevelopmetGuidance) to find how to make your custom configuration for Liquid Theme.
+Turn to [Document](https://github.com/Fentaniao/Liquid/blob/main/doc/Document,md) to find how to make your custom configuration for Liquid Theme.
 
 ## Contact
 

README_zh.md

@@ -25,20 +25,27 @@ typora-copy-images-to: ../../media/theme/Liquid
     <img alt="issues" src="https://img.shields.io/github/issues/fentaniao/liquid"/>
     <img alt="issues closed" src="https://img.shields.io/github/issues-closed/fentaniao/liquid"/>
 </p>
-
-[English Readme](https://github.com/Fentaniao/Liquid/blob/main/README.md) | [中文自述文件](https://github.com/Fentaniao/Liquid/blob/main/README_zh.md)
+[English Readme](https://github.com/Fentaniao/Liquid/blob/main/README.md) • [中文自述文件](https://github.com/Fentaniao/Liquid/blob/main/README_zh.md)
 
 为Typora精心设计的具有出色视觉效果的主题，灵感来源于[Microsoft Fluent Design](https://www.microsoft.com/design/fluent/#/) 和[Purple Theme](https://github.com/hliu202/typora-purple-theme)。 这个主题能够在Windows 11平台上为Typora提供出色的视觉体验。
 
+## 特性
+
+- 颜色交互
+- 渐变
+- 云母材质
+- 圆角
+- 多模式支持
+
 ## 支持
 
 - 系统：Windows 11 和Windows 10。
-- 模式：Light mode，Dark mode和Ink mode。
+- 模式：Light mode，Dark mode，Ink mode和Ink Dark Mode。
 - 语言：英语和中文。
 
 ## Screenshots
 
-Liquid Theme旨在为Windows 11中的Typora提供出色的视觉效果。我使用了现代UI的元素，如渐变、云母和圆角矩形。[点击这里](https://github.com/Fentaniao/Liquid/blob/main/Preview.md)查看关于Liquid主题的更多细节。
+Liquid Theme旨在为Windows 11中的Typora提供出色的视觉效果。我使用了现代UI的元素，如渐变、云母和圆角矩形。这个主题支持中文和英文，并且提供了四个模式——Light mode，Dark mode，Ink mode和Ink Dark Mode。
 
 ![preview](/media/theme/liquid/preview.png)
 
@@ -58,7 +65,7 @@ Liquid Theme旨在为Windows 11中的Typora提供出色的视觉效果。我使
 
 ![dark-preview3](/media/theme/liquid/dark-preview3.png)
 
-### Ink Mode
+### Ink Mode & Ink Dark Mode
 
 你可能使用像Microsoft Surface这样的二合一电脑来学习和写作，也有可能你只是喜欢手写字体，那么Ink Mode则为你提供了在Typora中使用手写字体来书写和阅读的机会。
 
@@ -75,16 +82,21 @@ Liquid Theme旨在为Windows 11中的Typora提供出色的视觉效果。我使
 3. 解压**Liquid.zip**到该文件夹中。
 4. 重启Typora。
 5. 在Typora的*主题* 选项中选择Liquid主题。
+6. 打开`Demo.md`查看渲染效果。
 
 ### 注意
 
 为了在Ink Mode下渲染中文字体，你仍需要将"liquid/FZSJ-SGLDXMHJW.TTF"安装到你的PC上。
 
+### 二次开发指南
+
+转到[开发文档](https://github.com/Fentaniao/Liquid/blob/main/doc/Document_zh.md)来了解如何进行二次开发。
+
 ## 联系
 
-作者: Fentaniao
+作者: [Fentaniao](https://github.com/Fentaniao)
 
-邮箱: Fentaniao@gmail.com
+邮箱: fentaniao@gmail.com
 
 ## 许可证
 

doc.md

@@ -0,0 +1,47 @@
+# Document for Liquid Theme
+
+## File Tree
+
+### Release
+
+```bash
+│  liquid-dark.css
+│  liquid-ink-dark.css
+│  liquid-ink.css
+│  liquid.css
+│  Demo.md
+│  Document.md
+│
+└─liquid # font files used
+```
+
+### Source Code
+
+```bash
+├─.github
+│  └─workflows
+├─dist # css combinded
+├─font # all font files
+├─media # picture of Liquid Theme
+└─src # source code
+   ├─Deploy # Python script to build release
+   └─liquid # part of css file
+```
+
+
+
+## Usage
+
+### Add Custom CSS (Recommended)
+
+It's the easiest way.
+
+Reference to https://support.typora.io/Add-Custom-CSS/ for help.
+
+### Modify the Released CSS File
+
+First install Liquid Theme to your PC, then modify the `xxxxx.css` file of Liquid Theme.
+
+### Modify Source Code of Project
+
+Download the `Source code (zip)` from the [Releases](https://github.com/Fentaniao/Liquid/releases) in [Liquid repository](https://github.com/Fentaniao/Liquid/), and then modify the CSS file under `scr` folder.

doc/Document.md

@@ -0,0 +1,47 @@
+# Liquid Theme的开发文档
+
+## 目录结构
+
+### Release
+
+```bash
+│  liquid-dark.css
+│  liquid-ink-dark.css
+│  liquid-ink.css
+│  liquid.css
+│  Demo.md
+│  Document.md
+│
+└─liquid # 使用到的字体文件
+```
+
+### 源代码
+
+```bash
+├─.github
+│  └─workflows
+├─dist # 组装好的CSS文件
+├─font # 所有的字体文件
+├─media # picture of Liquid Theme
+└─src # 有多么
+   ├─Deploy # 用于构建发布的Python脚本
+   └─liquid # CSS组件
+```
+
+
+
+## 用法
+
+### 添加自定义CSS（推荐）
+
+这是最简单的方法。
+
+查看https://support.typora.io/Add-Custom-CSS/以了解如何使用。
+
+### 修改发布的CSS文件
+
+首先将Liquid Theme安装到PC上，然后直接修改Liquid Theme的`xxxxx.css`文件.
+
+### 修改项目的源代码
+
+从[Releases](https://github.com/Fentaniao/Liquid/releases)页面下载`Source code (zip)`，然后修改`scr`目录下的CSS文件。