重构文档，同步部分语雀文档 (#126)

* init

* fix path and format

* Add badge

* 添加徽章使用文档

* 更新

* Update plugins.md

更新调整窗口的快捷键

* fix pangu space

---------

Co-authored-by: l0o0 <linxzh1989@gmail.com>

Author: northword

src/.vuepress/sidebar/user-guide.ts

@@ -3,18 +3,21 @@ import { arraySidebar } from "vuepress-theme-hope";
 export const userGuide = arraySidebar([
   //   "",
   "why-use-zotero",
+  "install",
   "quick-start",
   {
     text: "基础使用",
     icon: "module",
     // prefix: "basic-usage",
     collapsible: true,
     children: [
-      "install",
       "add-items",
+      "edit-items",
+      "add-attachments",
       "organize-library",
       "take-notes",
       "feed",
+      "import-from-other-software",
     ],
   },
   {
@@ -51,13 +54,13 @@ export const userGuide = arraySidebar([
     collapsible: true,
     children: "structure",
   },
-  {
-    text: "进阶教程",
-    icon: "creative",
-    // prefix: "advanced",
-    collapsible: true,
-    children: ["add-items-adv", "import-from-other-software.html"],
-  },
+  // {
+  //   text: "进阶教程",
+  //   icon: "creative",
+  //   // prefix: "advanced",
+  //   collapsible: true,
+  //   children: ["add-items-adv", "import-from-other-software.html"],
+  // },
   {
     text: "杂项",
     icon: "advance",

src/.vuepress/theme.ts

@@ -100,6 +100,50 @@ export default hopeTheme({
               };
           },
         },
+        {
+          matcher: "推荐",
+          replacer: ({ tag }) => {
+            if (tag === "em")
+              return {
+                tag: "Badge",
+                attrs: { type: "tip" },
+                content: "推荐",
+              };
+          },
+        },
+        {
+          matcher: "初级",
+          replacer: ({ tag }) => {
+            if (tag === "em")
+              return {
+                tag: "Badge",
+                attrs: { type: "tip" },
+                content: "初级",
+              };
+          },
+        },
+        {
+          matcher: "中级",
+          replacer: ({ tag }) => {
+            if (tag === "em")
+              return {
+                tag: "Badge",
+                attrs: { type: "tip" },
+                content: "中级",
+              };
+          },
+        },
+        {
+          matcher: "高级",
+          replacer: ({ tag }) => {
+            if (tag === "em")
+              return {
+                tag: "Badge",
+                attrs: { type: "tip" },
+                content: "高级",
+              };
+          },
+        },
       ],
       sub: true,
       sup: true,

src/contributing/markdown.md

@@ -7,6 +7,8 @@ updated: 2023-11-23 22:39:41
 
 # 文档风格指南
 
+[[TOC]]
+
 ## 文件命名
 
 文档网站根据每个 Markdown 源文件的路径确定每个页面的路由。因而，确定文件名时应慎重，一旦确定，尽量不要再改动。
@@ -121,7 +123,7 @@ updated: 2023-07-21 18:39:41
 ```md
 这是一段文本，
 **用两对星号包裹的内容会被加粗**，
-而*只用一对星号包裹的内容会显示为斜体*，
+而*只用一对星号（或下划线）包裹的内容会显示为斜体*，
 用~~两对波浪线包裹的内容会显示为删除~~，
 上下标：19^th^ H~2~O，
 你可以标记 ==重要的内容== 。
@@ -130,11 +132,31 @@ updated: 2023-07-21 18:39:41
 预览：
 这是一段文本，
 **用两对星号包裹的内容会被加粗**，
-而*只用一对星号包裹的内容会显示为斜体*，
+而*只用一对星号（或下划线）包裹的内容会显示为斜体*，
 用~~两对波浪线包裹的内容会显示为删除~~，
 上下标：19^th^ H~2~O，
 你可以标记 ==重要的内容== 。
 
+### 徽章 _推荐_
+
+可以通过徽章来标记文档阅读难度、推荐等。语法是将类型放入一对 `_` （斜体）中。可以在正文和标题中使用，但是不能在一级标题（页面标题）中使用。
+
+```md
+_初级_
+_中级_
+_高级_
+_推荐_
+
+通过 DOI 更新元数据 _初级_ 。
+```
+
+_初级_
+_中级_
+_高级_
+_推荐_
+
+通过 DOI 更新元数据 _初级_ 。
+
 ### 无序列表和有序列表
 
 ```md
@@ -376,13 +398,17 @@ console.log(foo(5));
 
 ### 脚注
 
+脚注内容就近放置，以方便阅读源文本。
+
 ```md
 这是一段文本[^1]
 
 [^1]: 这是一个脚注
 ```
 
-脚注内容就近放置，以方便阅读源文本。
+这是一段文本[^1]
+
+[^1]: 这是一个脚注
 
 ### 引用
 
@@ -394,6 +420,12 @@ console.log(foo(5));
 这是另一段正文文本
 ```
 
+这是一段正文文本
+
+> 这是一段引用文本
+
+这是另一段正文文本
+
 ::: tip
 
 除上述文字样式外，不使用 html 语法改变文字样式，仅在特殊情况下使用 html 语法增添文档的趣味性。

src/user-guide/README.md

@@ -22,9 +22,21 @@ updated: 2023-07-20 16:51:54
 
 本文档分为以下几个部分：
 
-- Zotero 使用教程（施工中）
-- Zotero 常见问题（施工中）
-- Zotero 资源合集（施工中）
+- **为什么使用 Zotero**：关于 Zotero 的优势，与其他同类软件的对比
+- **安装**：安装 Zotero 桌面端、浏览器插件、移动端的步骤
+- **Zotero 使用教程**
+  - **基础使用**：包括导入条目 _初级_、编辑条目 _中级_、导入文件 _初级_、添加分类和标签 _初级_、阅读和笔记 _初级_ 等
+  - **创建参考文献**：主要包括在 Word 中插入参考文献相关的内容 _中级_
+  - **同步、备份和协作**：包括同步数据 _中级_、备份数据 _高级_、创建群组 *高级*等
+  - **插件**：关于如何安装插件、优秀插件推荐等 _中级_
+- **Zotero 常见问题**：导入条目的问题合集、插入引用的问题合集等，非常规用法等
+- **Zotero 资源合集**：施工中
+
+::: tip 内容分级
+
+文档内容会有标记 _初级_、_中级_ 和 _高级_，读者初次了解 Zotero 时，仅需要掌握“初级”内容，随着了解和使用的深入，再探究更高难度的用法。
+
+:::
 
 由于内容较多，建议当作字典使用，在遇到问题时通过**顶部搜索栏搜索关键字**，例如遇到同步问题，则搜索“同步”。
 
@@ -38,7 +50,7 @@ updated: 2023-07-20 16:51:54
   - [Zotero 常用插件下载国内镜像](https://plugins.zotero-chinese.com/#/)
   - [中文 CSL 样式](https://github.com/redleafnew/Chinese-STD-GB-T-7714-related-csl/)
 - Zotero 开发者
-  - [Zotero 插件开发中文文档](https://zotero.yuque.com/books/share/8d230829-6004-4934-b4c6-685a7001bfa0?view=doc_embed)
+  - [Zotero 插件开发中文文档](../plugin-dev-guide/README.md)
   - [CSL 中文文档](../csl-dev-guide/README.md)
 - 更多 Zotero 相关文档
   - Zotero Better Notes 笔记插件中文文档：[Zotero Better Notes：基于知识的笔记插件](https://zotero.yuque.com/books/share/f3fe159f-956c-4f10-ade3-c87559cacb60?view=doc_embed)
@@ -53,3 +65,11 @@ updated: 2023-07-20 16:51:54
   以往 Zotero 使用中遇到问题，往往在群里提问，或者在相关教程/视频下留言，消息容易被刷掉或遗漏，效率低下。
 
 为了解决上述问题，我们创建了这个 Zotero 百科全书文档，权威、准确、一站式解决 Zotero 使用问题。
+
+## ❤️ 贡献指南
+
+::: tip 我如何参与到文档维护中？
+
+请参阅：[贡献指南](../contributing/contributing.md)。
+
+:::

src/user-guide/add-attachments.md

@@ -0,0 +1,40 @@
+---
+icon: add
+---
+
+# 添加附件
+
+除了项目元数据、注释和标签之外，Zotero 还可以用于管理文件。本页面介绍了将文件添加到 Zotero 库的不同方式，以及如何存储和同步添加的文件。
+
+## 子附件和独立附件
+
+::: note Todo
+
+参考：<https://www.zotero.org/support/attaching_files>
+
+:::
+
+## 存储的附件和链接的附件
+
+- 存储的附件![icon-pdf.png](../assets/icon-pdf.png)：默认情况下，存储文件存储在 Zotero 数据目录中，Zotero 会自动管理它们，包括在 Zotero 中删除附件项时删除它们。如果使用文件同步功能，Zotero 会自动在设备之间同步存储的附件，并将它们储存在官方网盘（或 WebDAV 网盘）中。
+- 链接的附件![icon-链接的附件.png](../assets/icon-链接的附件.png)：对于链接文件，Zotero 只存储指向计算机上原始文件位置的链接。链接文件不会同步，如果附件项在 Zotero 中被删除，链接文件也不会被删除，Zotero 程序也不支持链接文件的同步。（可以简单理解为链接的文件在 Zotero 中作用类似于 Windows 的快捷方式）
+
+## 为条目添加附件
+
+### 通过拖放
+
+::: note Todo
+
+:::
+
+### 通过附件菜单
+
+![添加附件](../assets/image-添加附件.png)
+
+## 附件重命名
+
+::: note Todo
+
+参考：<https://www.zotero.org/support/file_renaming>
+
+:::