[v0.4.0] update docs

jinzcdev · Feb 15, 2023 · 0d59ca9 · 0d59ca9
1 parent 8461f78
commit 0d59ca9
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,14 @@
 
 ---
 
+## [0.4.0] - 2023/02/15
+
+### 新增
+
+- 增加了 **笔记** 功能。你可以在代码编辑区键入 `ptanote` 生成笔记块，在其中输入你的笔记，下次预览题目时，笔记会以 Markdown 的形式解析并预览（笔记是随着代码一起提交到 拼题A 的，并不存在本地）
+
+---
+
 ## [0.3.1] - 2023/01/25
 
 ### 更新

diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@
 ### 1.1 登录/登出
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/jinzcdev/vscode-pintia/main/docs/imgs/signin.png" alt="Sign in" />
+  <img src="https://raw.githubusercontent.com/jinzcdev/vscode-pintia/main/docs/imgs/signin.png" alt="登录" />
 </p>
 
 
@@ -101,7 +101,19 @@
 
 ---
 
-### 1.6 代码片段
+### 1.6 笔记功能
+
+你可以在代码编辑区键入 `ptanote` 生成笔记块，在其中输入你的笔记，下次预览题目时，笔记会以 Markdown 的形式解析并预览。
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/jinzcdev/vscode-pintia/main/docs/imgs/note.png" alt="笔记" />
+</p>
+
+> :star: **Note:** 笔记是随着代码一起提交到 拼题A 的，并不存在本地。提交代码后，重新点击编辑器的 `Preview`，或者下次预览本题时，会显示你的笔记。
+
+---
+
+### 1.7 代码片段
 
 你可以在代码编辑器中输入以下前缀来快速生成相应的代码块，如下所示。
 
@@ -114,6 +126,7 @@
 | ptaclang | 获取带有头文件 `stdio.h` 的 clang 模板 |
 | ptajava_buffer | 获取带有 `BufferReader` 的 java 模板 |
 | ptajava_scanner | 获取带有 `Scanner` 的 java 模板 |
+| ptanote | 生成 `@pintia note=start/end` 笔记块 |
 
 ---
 

diff --git a/docs/CHANGELOG_en-US.md b/docs/CHANGELOG_en-US.md
@@ -4,6 +4,14 @@
 
 ---
 
+## [0.4.0] - 2023/02/15
+
+### Added
+
+- Add **notebook** feature. Now, you can type `ptanote` in the code editor to generate a **note block**, where you can enter your notes, and the next time you preview the problem, the notes will be parsed and previewed in Markdown
+
+---
+
 ## [0.3.1] - 2023/01/25
 
 ### Change

diff --git a/docs/README_en-US.md b/docs/README_en-US.md
@@ -90,7 +90,7 @@ And then click `Test custom sample` to quickly test your code.
 
 ---
 
-### 1.6 Search for Problems
+### 1.5 Search for Problems
 
 Click the `Search` icon at the top of the `Pintia` view or open the `Command Palette` to use shortcut command `Pintia: Search Problem`.
 
@@ -100,7 +100,18 @@ Click the `Search` icon at the top of the `Pintia` view or open the `Command Pal
 
 ---
 
-### 1.5 Snippets
+### 1.6 Notebook
+
+you can type `ptanote` in the code editor to generate a **note block**, where you can enter your notes, and the next time you preview the problem, the notes will be parsed and previewed in Markdown.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/jinzcdev/vscode-pintia/main/docs/imgs/note.png" alt="Note" />
+</p>
+
+> :star: **Note:** Your notes are submitted to PTA along with the code, not stored locally. After submitting the code, re-click `Preview` in the editor, or the next time you preview problems, your notes will be displayed on the preview page of the problem.
+
+---
+### 1.7 Snippets
 
 You can enter the following prefixs in code editor to generate the corresponding code blocks quickly, as follows:
 
@@ -113,6 +124,7 @@ You can enter the following prefixs in code editor to generate the corresponding
 | ptaclang | Get the template of clang with header file of `stdio.h` |
 | ptajava_buffer | Get the template of java with `BufferReader` |
 | ptajava_scanner | Get the template of java with `Scanner` |
+| ptanote | Generate `@pintia note=start/end` block |
 
 ---
 

diff --git a/docs/imgs/note.png b/docs/imgs/note.png
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
     "name": "vscode-pintia",
     "displayName": "Pintia",
     "description": "%description%",
-    "version": "0.3.1",
+    "version": "0.4.0",
     "author": "Zhichao Jin",
     "publisher": "jinzcdev",
     "license": "MIT",