feature: add doc

2025-06-07 20:08:54 +00:00 · 2021-12-08 22:31:39 +08:00 · 2021-12-08 22:31:39 +08:00 · b47f5b539e
commit b47f5b539e
parent 683146ecb0
24 changed files with 303 additions and 302 deletions
--- a/docs/features/Graph目录可视化.md
+++ b/docs/features/Graph目录可视化.md
@ -1,22 +1,22 @@
 # Graph目录可视化
-Foam comes with a graph visualization of your notes.
+Foam 带有笔记的图形可视化。
-To see the graph execute the `Foam: Show Graph` command.
+输入`Foam: Show Graph`命令查看图表。
-## Graph Navigation
+## 图形导航
-With the graph you can:
+使用图表，你可以：
- highlight a node by hovering on it, to quickly see how it's connected to the rest of your notes
+- 通过将鼠标悬停在节点上来突出显示它，以快速查看它是如何连接到你的笔记的其余部分的
- select one or more (by keeping `shift` pressed while selecting) nodes by clicking on them, to better understand the structure of your notes
+- 通过单击节点来选择一个或多个（通过在选择时按住`shift`键）节点，以更好地理解笔记的结构
- navigate to a note by clicking on it while pressing `ctrl` or `cmd`
+- 按下`ctrl`或`cmd`的同时点击它，导航到一个笔记
- automatically center the graph on the currently edited note, to immediately see its connections
+- 自动将当前的笔记放在图的中心，以立即查看其连接
-## Custom Graph Styles
+## 自定义图形样式
-By default, the Foam graph will use the VS Code theme, but it's possible to customize it with the `foam.graph.style` setting.
+默认情况下，泡沫图将使用 VS Code 主题，但可以使用 `foam.graph.style` 设置对其进行自定义。
-A sample configuration object is provided below, you can provide as many or as little configuration as you wish:
+下面提供了一个示例配置对象，你可以根据需要提供任意数量的配置：
 ```json
 "foam.graph.style": {
@ -31,8 +31,8 @@ A sample configuration object is provided below, you can provide as many or as l
 }
 ```
- `note` defines the color for regular nodes
+- `note` 定义了常规节点的颜色
- `placeholder` defines the color for links that don't match any existing note. This is a [[placeholder]] because no file with such name exists (see [[wikilinks]] for more info).
+- `placeholder` 定义与任何现有笔记不匹配的链接的颜色。 这是一个 [[placeholder]] 因为不存在具有这样名称的文件（请参阅 [[维基链接]] 了解更多信息）。
- `feature` shows an example of how you can use note types to customize the graph. It defines the color for the notes of type `feature`
+- `feature` 显示了如何使用笔记类型自定义图表的示例。 它定义了`feature`类型的笔记的颜色
-  - see [[note-properties]] for details
+  - 详见 [[笔记属性]]
-  - you can have as many types as you want
+  - 你可以拥有任意数量的类型
--- a/docs/features/daily-notes.md
+++ b/docs/features/daily-notes.md
@ -1,42 +0,0 @@
 # Daily Notes
 Daily notes allow you to quickly create and access notes for today.
 Try it out, run the `Foam: Open Daily Note` command.
 ## Shortcuts and Snippets
 You can quickly open today's daily note by pressing `alt+d`.
 You can also automatically open today's note via the `Foam › Open Daily Note: On Startup` setting.
 You can also quickly create link to your daily notes, in the configured format, using [snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets).
 Type `/today` and press `enter` to link to today's note.
 You can also write:
 | Snippet      | Date          |
 | ------------ | ------------- |
 | `/tomorrow`  | tomorrow      |
 | `/yesterday` | yesterday     |
 | `/monday`    | next Monday   |
 | `/+1d`       | tomorrow      |
 | `/-3d`       | 3 days ago    |
 | `/+1w`       | in a week     |
 | `/-1m`       | one month ago |
 | `/+1y`       | in one year   |
 You get the idea ;)
 ## Configuration
 It's possible to customize path and heading of your daily notes, by following the [dateformat masking syntax](https://github.com/felixge/node-dateformat#mask-options).
 The following properties can be used:
 ```json
  "foam.openDailyNote.directory": "journal",
  "foam.openDailyNote.filenameFormat": "'daily-note'-yyyy-mm-dd",
  "foam.openDailyNote.fileExtension": "mdx",
  "foam.openDailyNote.titleFormat": "'Journal Entry, ' dddd, mmmm d",
 ```
 The above configuration would create a file `journal/daily-note-2020-07-25.mdx`, with the heading `Journal Entry, Sunday, July 25`.
--- a/docs/features/link-reference-definitions.md
+++ b/docs/features/link-reference-definitions.md
@ -1,31 +0,0 @@
 # Link Reference Definitions
 When you use `[[wikilinks]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension can generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file.
 This is done to make the content of the file compatible with various Markdown tools (e.g. parsers, static site generators, VS code plugins etc), which don't support `[[wikilinks]]` directly.
 This feature can be disabled by default (as it's done in the foam-template) because you don't need it to navigate your workspace, it is useful for publishing and compatibility of your notes.
 ## Example
 The following example:
  ```md
  - [[graph-visualization]]
  ```
 ...generates the following link reference definitions to the bottom of the file:
  ```md
  [graph-visualization]: graph-visualization "Graph Visualization"
  ```
 ## Configuration
 You can use the `foam.edit.linkReferenceDefinitions` to configure the definitions (see [[get-started-with-vscode]]):
 - `withoutExtensions` (default): this works better with certain web publishing tools (e.g. GitHub pages)
 - `withExtensions`: this works better with standard markdown-based tools (e.g GitHub web UI)
 - `off`: this disables the generation of definitions
 After changing the setting in your workspace, you can run the `Foam: Run Janitor (Experimental)` command to convert all existing definitions.
--- a/docs/features/note-properties.md
+++ b/docs/features/note-properties.md
@ -1,30 +0,0 @@
 ---
 type: feature
 keywords: hello world
 ---
 # Note Properties
 At the top of the file you can have a section where you define your properties.
 > Be aware that this section needs to be at the very top of the file to be valid
 For example, for this file, we have:
 ```text
 ---
 type: feature
 keywords: hello world
 ---
 ```
 Those are properties.
 Properties can be used to organize your notes.
 ## Special Properties
 Some properties have special meaning for Foam:
 - the `title` property will assign the name to the note that you will see in the graph, regardless of the filename or the first heading (also see how to [[write-notes-in-foam]])
 - the `type` property can be used to style notes differently in the graph (also see [[graph-visualization]])
 - the `tags` property can be used to add tags to a note (see [[tags-and-tag-explorer]])
--- a/docs/features/note-templates.md
+++ b/docs/features/note-templates.md
@ -1,7 +0,0 @@
 # Note Templates
 You can create notes from templates by running the `Foam: Create New Note from Template` command and follow the instructions.
 To create a template, just add regular `.md` files in `.foam/templates` (create the directory if necessary).
 Templates can use all the variables available in [VS Code Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables).
--- a/docs/features/tags标签和标签浏览器.md
+++ b/docs/features/tags标签和标签浏览器.md
@ -4,19 +4,19 @@ tags: my-tag1 my-tag2
 # Tags标签和标签浏览器
-## Tags
+## 标签
-You can add tags to your notes to categorize them, or in any way you want.
+你可以在笔记中添加标签以对它们进行分类，或者以任何你想要的方式进行分类。
-There are two ways to add tags:
+添加标签有两种方式：
- you can add #tags just by writing them in the note
+- 你只需将 #tags 写在笔记中即可添加
- another way is through [[note-properties]], as you can see at the top of this file
+- 另一种方法是通过 [[笔记属性]]，如你在此文件的顶部所见
-## Tag Explorer
+## 标签浏览器
-In the sidebar to the left, you will see a panel called `Tag Explorer`.
+在左侧的边栏中，你将看到一个名为`Tag Explorer`的面板。
-You can use this panel to see the tags in your notes, and navigate them.
+你可以使用此面板查看笔记中的标签并导航它们。
-Notice `my-tag1` and `my-tag2`, which were added via [[note-properties]].
+请注意 `my-tag1` 和 `my-tag2`，它们是通过 [[笔记属性]] 添加的。
--- a/docs/features/wikilinks.md
+++ b/docs/features/wikilinks.md
@ -1,13 +0,0 @@
 # Wikilinks
 Wikilinks are the internal links that connect the files in your knowledge base.
 To create a wikilink use `[[` and type the name of another file in your repo, for example [[graph-visualization]]
 You can also create a [[placeholder]].
 A placeholder is a wikilink that doesn't have a target file and a link to a placeholder is styled differently so you can easily tell them apart.
 They can still be helpful to highlight connections.
 Open the graph with `Foam: Show Graph` command, and look at the placeholder node.
 Remember, with `CTRL/CMD+click` on a wikilink you can navigate to the note, or create it (if the link is a placeholder).
--- a/docs/features/拼写检查.md
+++ b/docs/features/拼写检查.md
@ -1,17 +1,17 @@
 # 拼写检查
-Foam comes with a spell checker.
+Foam 带有拼写检查器。
-Misspelled words are highlighted, like hellow.
+拼写错误的单词会被突出显示，比如hellow.
-You can place the cursor on top of the word, and press `cmd+.` for suggestions on how to fix the problem.
+你可以将光标放在单词的顶部，然后按`cmd+.`以获取有关如何解决问题的建议。
-You can configure the extension in the settings, for example to:
+你可以在设置中配置扩展，例如：
- ignore certain files
+- 忽略某些文件
- change the language(s)
+- 更改语言
- and much more
+- 以及更多
-For more information go to the [Spellright extension page](https://marketplace.visualstudio.com/items?itemName=ban.spellright).
+有关更多信息，请访问 [Spellright 扩展页面](https://marketplace.visualstudio.com/items?itemName=ban.spellright).
-There are many spell checking extensions for VS Code.
+VS Code 有许多拼写检查扩展。
-Another one of our favorites is [LTeX](https://marketplace.visualstudio.com/items?itemName=valentjn.vscode-ltex&ssr=false#overview), which is a bit heavier but offers some extra functionality.
+我们最喜欢的另一个是 [LTeX](https://marketplace.visualstudio.com/items?itemName=valentjn.vscode-ltex&ssr=false#overview), 它有点重，但提供了一些额外的功能。
--- a/docs/features/日常笔记.md
+++ b/docs/features/日常笔记.md
@ -0,0 +1,42 @@
 # 日常笔记
 每日笔记可让你快速创建和访问今天的笔记。
 试试看，运行`Foam: Open Daily Note`命令。
 ## 快捷方式和模版
 你可以通过按`alt+d`快速打开今天的每日笔记。
 你还可以通过`Foam › Open Daily Note: On Startup`设置自动打开今天的笔记。
 你还可以使用[snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets)以配置的方式快速创建指向日常笔记的超链接。
 输入`/today`并按`enter`链接到今天的笔记。
 你也可以写:
 | Snippet      | Date          |
 | ------------ | ------------- |
 | `/tomorrow`  | tomorrow      |
 | `/yesterday` | yesterday     |
 | `/monday`    | next Monday   |
 | `/+1d`       | tomorrow      |
 | `/-3d`       | 3 days ago    |
 | `/+1w`       | in a week     |
 | `/-1m`       | one month ago |
 | `/+1y`       | in one year   |
 你懂的 ;)
 ## 配置
 通过遵循[日期格式特征语法](https://github.com/felixge/node-dateformat#mask-options)，可以自定义日常笔记的路径和标题。
 可以使用以下属性：
 ```json
  "foam.openDailyNote.directory": "journal",
  "foam.openDailyNote.filenameFormat": "'daily-note'-yyyy-mm-dd",
  "foam.openDailyNote.fileExtension": "mdx",
  "foam.openDailyNote.titleFormat": "'Journal Entry, ' dddd, mmmm d",
 ```
 上述配置将创建一个文件`journal/daily-note-2020-07-25.mdx`，标题为`Journal Entry, Sunday, July 25`。
--- a/docs/features/笔记属性.md
+++ b/docs/features/笔记属性.md
@ -0,0 +1,32 @@
 ---
 type: feature
 keywords: hello world
 ---
 # 笔记属性
 笔记属性
 在文件的顶部，你可以有一个部分来定义你的属性。
 > 请注意，此部分需要位于文件的最顶部才能有效
 例如，对于这个文件，我们有：
 ```text
 ---
 type: feature
 keywords: hello world
 ---
 ```
 那些是属性。
 属性可用于组织你的笔记。
 ## 特殊属性
 一些属性对泡沫具有特殊意义：
 - `title` 属性将为你将在图表中看到的笔记分配名称，而不管文件名或第一个标题（另请参阅如何 [[write-notes-in-foam]]）
 - `type` 属性可用于在图表中设置不同的样式（另见 [[Graph目录可视化]]）
 - `tags` 属性可用于向笔记添加标签（参见 [[tags标签和标签浏览器]]）
--- a/docs/features/笔记模版.md
+++ b/docs/features/笔记模版.md
@ -0,0 +1,7 @@
 # 笔记模版
 你可以通过运行`Foam: Create New Note from Template`命令并按照说明从模板创建笔记。
 要创建模板，只需在`.foam/templates`中添加常规的`.md`文件（如有必要，请创建目录）。
 模板可以使用[VS Code Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables) 中的所有可用变量。
--- a/docs/features/维基链接.md
+++ b/docs/features/维基链接.md
@ -0,0 +1,13 @@
 # 维基链接
 维基链接是连接知识库中文件的内部链接。
 要创建维基链接，请使用 `[[` 并在你的仓库中输入另一个文件的名称，例如 [[Graph目录可视化]]
 你还可以创建一个 [[占位符]].
 占位符是没有目标文件的 wiki 链接，并且占位符的链接的样式不同，因此你可以轻松区分它们。
 它们仍然有助于突显连接。
 使用`Foam: Show Graph`命令打开图形，然后查看占位符节点。
 请记住，使用维基链接上的`CTRL/CMD+click`，你可以导航到该笔记，或创建它（如果该链接是占位符）。
--- a/docs/features/链接参考定义.md
+++ b/docs/features/链接参考定义.md
@ -0,0 +1,31 @@
 # 链接参考定义
 当你使用`[[维基链接]]`时，[foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode)插件在文件底部可以生成[Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions)。
 这样做是为了使文件的内容与不直接支持`[[维基链接]]`的各种 Markdown 工具（例如解析器、静态站点生成器、VS 代码插件等）兼容。
 默认情况下可以禁用此功能（就像在foam模板中所做的那样），因为你不需要它来导航你的工作区，它对于发版和兼容笔记非常有用。
 ## 示例
 下面的例子 :
  ```md
  - [[Graph目录可视化]]
  ```
 ...在文件底部生成以下链接引用定义:
  ```md
  [Graph目录可视化]: Graph目录可视化"Graph目录可视化"
  ```
 ## 配置
 你可以使用 `foam.edit.linkReferenceDefinitions` 来配置定义（参见 [[VS-Code-入门指南]）：
 - `withoutExtensions`（默认）：这对某些网络发布工具（例如 GitHub 页面）效果更好
 - `withExtensions`：使用基于 Markdown 的标准工具（例如 GitHub Web UI）效果更好
 - `off`：禁用定义的生成
 更改工作区中的设置后，你可以运行 `Foam: Run Janitor (Experimental)` 命令来转换所有现有定义。
--- a/docs/how-to/VS-Code-入门指南.md
+++ b/docs/how-to/VS-Code-入门指南.md
@ -1,43 +1,43 @@
 # VS-Code-入门指南
-VS Code is a powerful text editor, hidden behind a simple interface.
+VS Code 隐藏在一个简单的界面后面,是一个强大的文本编辑器。
-VS Code supports various **keyboard shortcuts**, the most important for us are:
+VS Code 支持各种**快捷键**，对我们来说最重要的是：
-| Shortcut      | Action                       |
+| 快捷键        | 动作                    |
-| ------------- | ---------------------------- |
+| ------------- | ----------------------- |
-| `cmd+N`       | create a new file            |
+| `cmd+N`       | 创建新文件              |
-| `cmd+S`       | save the current file        |
+| `cmd+S`       | 保存当前文件            |
-| `cmd+O`       | open a file                  |
+| `cmd+O`       | 打开一个文件            |
-| `cmd+P`       | use quickpick to open a file |
+| `cmd+P`       | 使用 quickpick 打开文件 |
-| `cmd+shift+P` | invoke a command (see below) |
+| `cmd+shift+P` | 调用命令（见下文）      |
-For more information, see the [VS Code keyboard cheat sheets](https://code.visualstudio.com/docs/getstarted/keybindings#_keyboard-shortcuts-reference), where you can also see how to customize your keybindings.
+有关详细信息，请参阅 [VS Code 快捷键表](https://code.visualstudio.com/docs/getstarted/keybindings#_keyboard-shortcuts-reference)，你还可以在其中了解如何自定义快捷键。
-## Commands
+## 命令
-Commands make VS Code extremely powerful.
+命令使 VS Code 非常强大。
-To invoke a command, press `cmd+shift+P` and select the command you want to execute.
+要调用命令，请输入`cmd+shift+P`并选择要执行的命令。
-For example, to see the Foam graph:
+例如，要查看泡沫图：
- press `cmd+shift+P`
+- 输入 `cmd+shift+P`
- start typing `show graph`
+- 输入 `show graph`
- select the `Foam: Show Graph` command
+- 选择 `Foam: Show Graph` 命令
-And watch the magic unfold.
+查看奇迹发生。
-For more information on commands, see [commands on the VS Code site](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
+有关命令的更多信息，请参阅 [VS Code 命令](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)。 
-If you want to learn more about VS Code, check out their [website](https://code.visualstudio.com/docs#first-steps).
+如果你想了解有关 VS Code 的更多信息，请查看他们的 [网站](https://code.visualstudio.com/docs#first-steps)。
-## Panels
+## 面板
-You can see a few panels on the left, including:
+你可以在左侧看到几个面板，包括：
- `Outline`: this panel shows you the structure of the file based on the headings
+- `Outline`: 此面板根据标题向你显示文件的结构
- `Tag Explorer`: This shows you the tags in your workspace, see [[tags-and-tag-explorer]] for more information on tags
+- `Tag Explorer`: 这会显示你工作区中的标签，有关标签的更多信息，请参阅 [[Tags标签和标签浏览器]]
-## Settings
+## 设置
-To view or change the settings in VS Code, press `cmd+,`
+要查看或更改 VS Code 中的设置，请按 `cmd+,`。
--- a/docs/how-to/paste-images-from-clipboard.md
+++ b/docs/how-to/paste-images-from-clipboard.md
@ -1,14 +0,0 @@
 # Paste Images from Clipboard
 You can paste an image from the clipboard with `cmd+alt+v`.
 Images are automatically copied to the `/attachments` folder and a reference is added in the file where you pasted them.
 A prompt will ask you to confirm the name of the image, to disable it set `"pasteImage.showFilePathConfirmInputBox": false,` in the settings.
 To change the location where the image is created, change the `pasteImage.path` property, e.g.:
 - `${currentFileDir}`: save the image next to the file
 - `${currentFileDir}/images`: create an `images` directory next to the file and save the image there
 For more info check the [vscode-paste-image](https://github.com/mushanshitiancai/vscode-paste-image) extension page.
--- a/docs/how-to/shortcut-list.md
+++ b/docs/how-to/shortcut-list.md
@ -1,13 +0,0 @@
 # Shortcut-List
 You can use either the name or the id to find each shortcut in the settings (File > Preferences > Keyboard Shortcuts) and find out what it is bound to on your system and change it according to your liking.
 | Shortcut       | Name            | ID                                      | Extension           | Use                                 |
 | -------------- | --------------- | --------------------------------------- | ------------------- | ----------------------------------- |
 | `alt+c`        | \-              | markdown.extension.checkTaskList        | Markdown All in One | Toggle TODO items.                  |
 | `cmd+b`        | \-              | markdown.extension.editing.toggleBold   | Markdown All in One | Make selection bold.                |
 | `cmd+i`        | \-              | markdown.extension.editing.toggleItalic | Markdown All in One | Make selection italic.              |
 | `ctrl+shift+f` | Format Document | editor.action.formatDocument            | Base                | Format tables                       |
 | `cmd+shift+f`  | Find files      | workbench.action.findInFiles            | Base                | Search in workspace.                |
 | `cmd+shift+e`  | Show Explorer   | workbench.view.explorer                 | Base                | Show the file explorer.             |
 | `cmd+alt+v`    | Paste Image     | extension.pasteImage                    | Paste Image         | Paste an image from your clipboard. |
--- a/docs/how-to/write-notes-in-foam.md
+++ b/docs/how-to/write-notes-in-foam.md
@ -1,69 +1,69 @@
-# Writing Notes
+# 写笔记
-Notes are simple text files with some extra flavor, in the shape of Markdown syntax and support for extra properties (see [[note-properties]]).
+笔记是带有一些额外风味的简单文本文件，采用 Markdown 语法的形式并支持额外的属性（请参阅 [[笔记属性]]）。
-## Foam Syntax
+## Foam 语法
-Foam uses standard Markdown, with a few added twists:
+Foam 使用标准 Markdown，并添加了一些改动：
- the title of a note (e.g. in the [[graph-visualization]]) is given by precedence based on:
+- 注释的标题（例如在 [[Graph目录可视化]] 中）由优先级给出，基于：
-  - the `title` property (see [[note-properties]])
+  - `title` 属性（见 [[笔记属性]]）
-  - the first `# heading 1` of the file
+  - 文件的第一个 `# 一级标题`
-  - the file name
+  - 文件名
-## Markdown Syntax
+## Markdown 语法
-With Markdown, we can style our notes in a simple way, while keeping the document a simple text file (the best way to future-proof your writings!).
+使用 Markdown，我们可以用一种简单的方式来设计我们的笔记，同时将文档保持为一个简单的文本文件（这是让你的作品面向未来的最佳方式！）。
-You can see the formatted output by running the `Markdown: Open Preview to the Side` command.
+你可以通过运行`Markdown: Open Preview to the Side`命令来查看格式化的输出。
-Here is a high level overview of Markdown, for more information on the Markdown syntax [see here](https://commonmark.org/help/).
+这是 Markdown 的高级概述，有关 Markdown 语法的更多信息 [请参阅此处](https://commonmark.org/help/)。
-# Heading 1
+# 一级标题
-## Heading 2
+## 二级标题
-### Heading 3
+### 三级标题
-#### Heading 4
+#### 四级标题
-##### Heading 5
+##### 五级标题
-###### Heading 6
+###### 六级标题
-This is a [link to google](https://www.google.com).
+这是一个[谷歌链接](https://www.google.com).
-This is a wikilink (aka internal link) to [[note-properties]].
+这是 [[笔记属性]] 的维基链接（又名内部链接）。
-Here is an image:
+这是一张图片：
-![image](../../attachments/foam-icon.png)
+![图片](../../attachments/foam-icon.png)
-> this is a blockquote
+> 这是块引用
-> it can span multiple lines
+> 它可以跨越多行
- list item
+- 项目清单
- list item
+- 项目清单
- list item
+- 项目清单
 1. One
 2. Two
 3. Three
-This text is **in bold** and this is *italic*.
+这段文字是**粗体**，这是*斜体*。
-The following is a horizontal rule
+下面是一条水平线
 ---
-This is a table:
+这是一张表格:
 | Column 1 | Column 2 |
 | -------- | -------- |
 | R1C1     | R1C2     |
 | R2C1     | R2C2     |
-You can `inline code` or
+你可以'内联代码'或
 ```text
-you can create
+你可以创造
-code blocks
+代码块
 ```
--- a/docs/how-to/从剪贴板粘贴图像.md
+++ b/docs/how-to/从剪贴板粘贴图像.md
@ -0,0 +1,14 @@
 # 从剪贴板粘贴图像
 你可以通过`cmd+alt+v`粘贴剪贴板中的图像.
 图像会自动复制到`/attachments` 文件夹，并在粘贴它们的文件中添加引用。
 提示将要求你确认图像的名称，在设置中设置`"pasteImage.showFilePathConfirmInputBox": false,` 来禁用它。
 要更改创建图像的位置，请更改 `pasteImage.path` 属性，例如：
 - `${currentFileDir}`: 将图像保存在当前文件旁边。
 - `${currentFileDir}/images`: 在文件旁边创建一个`images`目录并将图像保存在那里。
 有关更多信息，请查看 [vscode-paste-image](https://github.com/mushanshitiancai/vscode-paste-image) 扩展页面。
--- a/docs/how-to/使用快捷键进行编辑.md
+++ b/docs/how-to/使用快捷键进行编辑.md
@ -1,44 +1,44 @@
 # 使用快捷键进行编辑
-Here are some keyboard shortcuts you'll love when editing your notes.
+以下是你在编辑笔记时会喜欢的一些键盘快捷键。
->If you are not on mac or are using non-default shortcuts you can check the [[shortcut-list]] for each shortcut used in this note!
+>如果你不是在 mac 上或使用非默认快捷方式，你可以检查 [[快捷键列表]] 以获取本笔记中使用的每个快捷方式！
-This works best if you can see the result in the preview panel, run the `Markdown: Open Preview to the Side` command.
+运行`Markdown: Open Preview to the Side`命令，你可以在预览面板中看最佳的阅览效果。
- [ ] `alt+c` changes state to a TODO item. Try it while the cursor is on this line.
+- [ ] `alt+c` 更改 TODO 项的状态。 当光标在这一行上时尝试一下。
 ---
- [ ] `cmd+b` makes the selection bold. Select me and make me bold.
+- [ ] `cmd+b` 使选中内容加粗. 试试框选我并让我加粗。
 ---
- [ ] `cmd+i` makes the selection italic. Select me and make me italic.
+- [ ] `cmd+i` 使选中内容斜体。选择我并使我改为斜体。
 ---
- [ ] `alt+shift+f` formats a table. Place the cursor in the table below and format the table.
+- [ ] `alt+shift+f` 格式化表格。 将光标放在下表中并格式化(规整)表格。
-| column 1 | column 2|
+| 行1        | 行2          |
-|-|-|
+| ---------- | ------------ |
-| one element | another element|
+| 第一个元素 | 另外一个元素 |
-| second row| last cell|
+| 第二行     | 最后一格     |
 ---
- [ ] Paste link on selected text
+- [ ] 在所选文本上粘贴链接
-  1. copy the following text: https://google.com
+  1. 复制以下文字: https://google.com
-  2. select me and paste
+  2. 选择我并粘贴
 ---
- [ ] Search in your repo with `cmd+shift+f`: type "search"
+- [ ]使用`cmd+shift+f`在你的仓库中搜索 : 输入 "search"
-  - (go back to the file explorer with `cmd+shift+e`)
+  - (输入`cmd+shift+e`返回文件资源管理器)
 ---
- [ ] Paste an image
+- [ ] 粘贴图片
-  1. copy an image
+  1. 复制一张图片
-  2. move your cursor to the next line, then press `cmd+alt+v` and confirm the name of the file
+  2. 将光标移到下一行，然后按“cmd+alt+v”并确认文件名。
  3. .
-  4. the image file has been created in `/attachments` and a reference to it has been added here
+  4. 图像文件已在 `/attachments` 中创建，并在此处添加了对其的引用。
--- a/docs/how-to/快捷键列表.md
+++ b/docs/how-to/快捷键列表.md
@ -0,0 +1,13 @@
 # 快捷键列表
 你可以使用名称或 ID 在VS code 设置 (File > Preferences > Keyboard Shortcuts) 中找到每个快捷方式，并找出它在你系统上绑定键，并根据你的喜好进行更改。
 | 快捷键         | 名字            | ID                                      | 插件                | 用途               |
 | -------------- | --------------- | --------------------------------------- | ------------------- | ------------------ |
 | `alt+c`        | \-              | markdown.extension.checkTaskList        | Markdown All in One | 更改TODO的状态。   |
 | `cmd+b`        | \-              | markdown.extension.editing.toggleBold   | Markdown All in One | 使选择内容粗体。   |
 | `cmd+i`        | \-              | markdown.extension.editing.toggleItalic | Markdown All in One | 使选择内容斜体。   |
 | `ctrl+shift+f` | Format Document | editor.action.formatDocument            | Base                | 格式化表格。       |
 | `cmd+shift+f`  | Find files      | workbench.action.findInFiles            | Base                | 在笔记中查找。     |
 | `cmd+shift+e`  | Show Explorer   | workbench.view.explorer                 | Base                | 显示文件浏览器。   |
 | `cmd+alt+v`    | Paste Image     | extension.pasteImage                    | Paste Image         | 从剪贴板粘贴图像。 |
--- a/readme.md
+++ b/readme.md
@ -4,7 +4,7 @@
 **👋 欢迎使用你的Foam知识管理系统!**
- 使用`vscode`和`Foam构建你的`第二大脑`
+- 使用`vscode`和`Foam`构建你的`第二大脑`
 - 原文来自 [foam-template](https://github.com/foambubble/foam-template)
 ## 开始
@ -37,6 +37,6 @@
 ## 提交Issues
-您可能已经注意到，Issues已禁用。为了使项目易于维护，请将您的问题提交到主 Foam 存储库中：
+你可能已经注意到，Issues已禁用。为了使项目易于维护，请将你的问题提交到主 Foam 存储库中：
 > <https://github.com/foambubble/foam>
--- a/入门指南.md
+++ b/入门指南.md
@ -1,50 +1,47 @@
 # 入门指南
-欢迎来到您的新foam工作区，让我们开始吧。
+欢迎来到你的新foam工作区，让我们开始吧。
-> 如果您已经熟悉 Foam 并且不需要帮助，只需删除 `docs` 文件夹以获得干净的项目。
+> 如果你已经熟悉 Foam 并且不需要帮助，只需删除 `docs` 文件夹以获得干净的项目。
 让我们通过这个来设置你的仓库:
- [ ] 如果你是 VS Code 的新手, see how to [[VS-Code-入门指南]] and how to [[使用快捷键进行编辑]]
+- [ ] 如果你是 VS Code 的新手, 请阅读[[VS-Code-入门指南]]和怎样[[使用快捷键进行编辑]]
- [ ] you can navigate the links between your notes by `cmd+click` (or `ctrl+click` on Windows) on a wikilink. You can go back with `ctrl+-`. Here, go to your [[子弹笔记]]
+- [ ] 可以通过 `cmd+click` (or `ctrl+click` on Windows)点击超链接，在笔记文件间相互跳转。可以通过 `ctrl+-` 回到之前的页面。现在，点击跳转到你的[[子弹笔记]]
- [ ] to see how your notes are connected, execute the `Foam: Show Graph` command. See [[Graph目录可视化]].
+- [ ] 执行 `Foam: Show Graph` 命令，看看你的笔记是如何连接的。 请参阅[[Graph目录可视化]].
- [ ] #tags can be used to further organize your content. Look at the `Tag Explorer` view on the left panel to find and navigate the tags in your knowledge base. See [[tags标签和标签浏览器]].
+- [ ] #tags 能进一步组织你的内容，查看左侧面板上的`Tag Explorer`视图以查找和导航知识库中的标签。 请参阅 [[tags标签和标签浏览器]]
- [x] (已经放弃)Foam supports [[拼写检查]] .
+- [x] (已经放弃)Foam 支持 [[拼写检查]] .
- [ ] You can also paste images in your Foam, just press `cmd+alt+v` to create the image file and link to it from your note. See [[paste-images-from-clipboard]].
+- [ ] 你也可以在 Foam 中粘贴图像，只需按 `cmd+alt+v` 即可创建图像文件并从笔记中链接到该文件。 请参阅[[从剪贴板粘贴图像]].
- [ ] You can use Foam for your daily notes, or journaling. Execute now the `Foam: Open Daily Note` command to create a new file in your `journal` folder. See [[daily-notes]].
+- [ ] 你可以将 Foam 用于日常笔记或日记。现在执行`Foam: Open Daily Note` 命令，在你的 `journal` 文件夹中创建一个新文件。请参阅[[日常笔记]]。
- [ ] Want to see how to manage your tasks? Go to the [[todo]] note
+- [ ] 想了解如何管理你的任务？ 转到[[待办清单]]便签。
- [ ] The section at the end of this file contains wikilink definitions, which enable navigation of your notes from GitHub's web UI, and in general to make `[[wikilinks]]` understood by any Markdown parser. See [[link-reference-definitions]].
+- [ ] 此文件末尾的部分包含 wikilink(超链接) 定义，它允许从 GitHub 的 Web UI 导航你的笔记，并且通常使任何 Markdown 解析器都能理解 `[[维基链接]]` . See [[链接参考定义]].
- [ ] To explore all the Foam settings, press `cmd+,`, then `Extensions > Foam`
+- [ ] 查看foam所有的配置信息, 按 `cmd+,`, 然后 `Extensions > Foam`中找到所有配置信息。
- [ ] Living within VS Code, Foam can be customized in many ways! Look at the [Foam Recipes](https://foambubble.github.io/foam/recipes/recipes) for ideas!
+- [ ] 在 VS Code 中，Foam 可以通过多种方式进行定制 ! 在 [Foam Recipes](https://foambubble.github.io/foam/recipes/recipes) 中查看详细信息!
- [ ] Join the [Foam community on Discord](https://foambubble.github.io/join-discord/e), introduce yourself and leave a message on how you found Foam and how the onboarding went :) We are always keen to do better
+- [ ] 加入[Discord 上的Foam 社区](https://foambubble.github.io/join-discord/e), 介绍自己并留言说明你是如何找到Foam，:) 我们渴望做得更好。
- [ ] Take the [Foam Welcome survey](http://foambubble.github.io/welcome-survey/e)! It helps us better understand your need and how we can make Foam better and better for you :)
+- [ ] 参加 [Foam 新用户调查](http://foambubble.github.io/welcome-survey/e)! 它可以帮助我们更好地了解你的需求，以及我们如何为你制作越来越好的。
-## Advanced Features
+## 高级功能
- [ ] You can create [[note-templates]] for things like book reviews, people, daily notes (coming soon), and more!
+- [ ] 你可以为书评、人物、日常笔记（即将推出）等内容创建 [[笔记模版]]！
-## About Foam
+## 关于 Foam
-Foam doesn't do all this magic on its own, it relies on some amazing extensions. Look at their documentation if you want to fully unlock the possibilities!
+Foam 本身并不能发挥所有这些魅力，它依赖于一些优秀的扩展。如果你想完全了解他们的功能，请查看他们的文档！
 Here they are:
 - [Markdown All In One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
 - [vscode-paste-image](https://github.com/mushanshitiancai/vscode-paste-image)
 - [spellright](https://marketplace.visualstudio.com/items?itemName=ban.spellright)
-A special mention goes to [Markdown Links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links) and [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) which have now been replaced by our own implementation but were foundational to Foam's beginnings.
+特别提到的是[Markdown Links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links) 和 [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) 现在已经被我们自己的实现所取代，但它们是 Foam 开始的基础。
--- a/子弹笔记.md
+++ b/子弹笔记.md
@ -1,12 +1,14 @@
-# Inbox
+# 子弹笔记
- Here you can write disorganised notes to be categorised later
+- 在这里你可以编写杂乱无章的笔记，以便稍后进行分类
- Bullet points are useful, but it could be free form text as well
+- 项目符号很有用，但也可以是无格式的文字
- Sometimes it's better to just get things off your mind quickly, rather than stop to think where it belongs
+- 有时，写下你的想法，是更快速的把想法从你的脑海中剔除的方法，而不是停下来思考它的细节
- But don't let this list get too long
+  - Sometimes it's better to just get things off your mind quickly, rather than stop to think where it belongs
- Move information to more specific documents and link to them.
+  - FIXME:上面这句翻译的不够准确。
-  - This helps you navigate between documents quickly
+- 但不要让这个清单太长
-  - For example, you can `Cmd`+`Click` this: [[todo]]
+- 将信息移至更具体的文档并链接到它们。
- Some notes don't end up making sense the next day
+  - 这有助于你在文档之间快速导航跳转
- That's ok, you can just delete them!
+  - 例如，你可以`Ctrl`+`鼠标左键`这个：[[待办清单]]
-  - You can always find them in your git history, if you really need it!
+- 有些记录第二天就没有意义了
 - 没关系，你可以删除它们！
  - 如果你真的需要的话，你总是可以在你的 git 历史中找到它们！
--- a/待办清单.md
+++ b/待办清单.md
@ -4,5 +4,5 @@
 - [x] 这是一项已经被完成的事项的示例
 - [ ] 这一项还没有被完成
- [ ] 当你的光标在这一行上时，您可以通过按`Option`+`C`(or `Alt`+`C`)将其标记为完成
+- [ ] 当你的光标在这一行上时，你可以通过按`Option`+`C`(or `Alt`+`C`)将其标记为完成
-  - [ ] 您还可以选择多行并一次标记它们！
+  - [ ] 你还可以选择多行并一次标记它们！