diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 7b74b17..7083091 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -11,7 +11,5 @@ // Image-pasting for markdown "mushan.vscode-paste-image", - // Spell checking for text, markdown and latex - "ban.spellright", ] } diff --git a/docs/features/graph-visualization.md b/docs/features/Graph目录可视化.md similarity index 98% rename from docs/features/graph-visualization.md rename to docs/features/Graph目录可视化.md index 614a99d..0d2a22b 100644 --- a/docs/features/graph-visualization.md +++ b/docs/features/Graph目录可视化.md @@ -1,4 +1,4 @@ -# Graph Visualization +# Graph目录可视化 Foam comes with a graph visualization of your notes. To see the graph execute the `Foam: Show Graph` command. diff --git a/docs/features/tags-and-tag-explorer.md b/docs/features/tags标签和标签浏览器.md similarity index 94% rename from docs/features/tags-and-tag-explorer.md rename to docs/features/tags标签和标签浏览器.md index ea9bfb0..fdb0020 100644 --- a/docs/features/tags-and-tag-explorer.md +++ b/docs/features/tags标签和标签浏览器.md @@ -2,7 +2,7 @@ tags: my-tag1 my-tag2 --- -# Tags and Tag Explorer +# Tags标签和标签浏览器 ## Tags diff --git a/docs/features/spell-checking.md b/docs/features/拼写检查.md similarity index 97% rename from docs/features/spell-checking.md rename to docs/features/拼写检查.md index 7fd08b0..fdee0c1 100644 --- a/docs/features/spell-checking.md +++ b/docs/features/拼写检查.md @@ -1,4 +1,4 @@ -# Spell Checking +# 拼写检查 Foam comes with a spell checker. diff --git a/docs/how-to/get-started-with-vscode.md b/docs/how-to/VS-Code-入门指南.md similarity index 98% rename from docs/how-to/get-started-with-vscode.md rename to docs/how-to/VS-Code-入门指南.md index 859e4f7..964a95d 100644 --- a/docs/how-to/get-started-with-vscode.md +++ b/docs/how-to/VS-Code-入门指南.md @@ -1,4 +1,4 @@ -# Getting started with VS Code +# VS-Code-入门指南 VS Code is a powerful text editor, hidden behind a simple interface. diff --git a/docs/how-to/use-keyboard-shortcuts-for-editing.md b/docs/how-to/使用快捷键进行编辑.md similarity index 97% rename from docs/how-to/use-keyboard-shortcuts-for-editing.md rename to docs/how-to/使用快捷键进行编辑.md index 36bda21..4781dc3 100644 --- a/docs/how-to/use-keyboard-shortcuts-for-editing.md +++ b/docs/how-to/使用快捷键进行编辑.md @@ -1,4 +1,4 @@ -# Use Keyboard Shortcuts for Editing +# 使用快捷键进行编辑 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! diff --git a/readme.md b/readme.md index 480b6e0..7087816 100644 --- a/readme.md +++ b/readme.md @@ -2,44 +2,41 @@ # Foam -**👋 Welcome to your new Foam Knowledge Base!** +**👋 欢迎使用你的Foam知识管理系统!** -## Getting started +- 使用`vscode`和`Foam构建你的`第二大脑` +- 原文来自 [foam-template](https://github.com/foambubble/foam-template) -This documentation assumes that you have a GitHub account and have [Visual Studio Code](https://code.visualstudio.com/) installed on your Linux/macOS/Windows machine. +## 开始 -1. If you haven't yet, browse over to the main [Foam documentation](https://foambubble.github.io/foam) to get an idea of what Foam is and how to use it. -2. Press "Use this template" button at [foam-template](https://github.com/foambubble/foam-template/generate) (that's this repository!) to fork it to your own GitHub account. If you want to keep your thoughts to yourself, remember to set the repository private. -3. [Clone the repository to your local machine](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) and open it in VS Code. +本文档假设你有一个GitHub账户,并且在你的Linux/MacOS/Windows机器上安装了[Visual Studio Code](https://code.visualstudio.com/)。 - *Open the repository as a folder using the `File > Open...` menu item.* +1. 如果你想详细了解foam,请浏览一下[Foam文档](https://foambubble.github.io/foam)。 +2. 在[foam-template](https://github.com/foambubble/foam-template/generate)(就是本项目)项目上按"Use this template"按钮,复制到你的github帐号中。如果你想保密你的想法,请设置项目为私有项目(private)。 +3. [克隆(clone)这个项目到你的电脑本地](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository),并用VS Code打开它。 -4. When prompted to install recommended extensions, click **Install all** (or **Show Recommendations** if you want to review and install them one by one) + *使用`File > Open...` 用文件夹(folder)的方式打开它。* -After setting up the repository, head to [[getting-started]] to get familiar with your new knowledge base! +4. 被提示安装推荐的扩展程序时, 按**Install all**按钮(或者**Show Recommendations**如果你想逐一审查和安装它们) -To learn more about how to use **Foam**, read the [Recipes](https://foambubble.github.io/foam/recipes/recipes) bubbles of the Foam documentation workspace. +在设置好项目后, 首先点击[[入门指南]]去熟悉你的新笔记系统! -And remember that you can always join our [Foam community on Discord](https://foambubble.github.io/join-discord/g)! +系统学习**Foam**, 请阅读[Recipes](https://foambubble.github.io/foam/recipes/recipes)文档。 -## Using Foam +请记住,你可以随时加入我们的[Foam Discord社区](https://foambubble.github.io/join-discord/g)! -We've created a few Bubbles (Markdown documents) to get you started. +## 使用笔记系统 -- [[inbox]] - a place to write down quick notes to be categorized later -- [[getting-started]] - learn how to use your Foam workspace -- [[todo]] - a place to keep track of things to do +我们已经创建了一些Bubbles(Markdown文档)来让你开始。 -In the `docs` directory you can find everything you need to learn the basics of Foam. +- [[子弹笔记]] - 一个可以写下快速笔记的地方,以便以后进行分类。 +- [[入门指南]] - 学习如何使用你的Foam工作区 +- [[待办清单]] - 一个可以记录待办事情的地方 -[//begin]: # "Autogenerated link references for markdown compatibility" -[getting-started]: getting-started.md "Getting Started" -[inbox]: inbox.md "Inbox" -[todo]: todo.md "Todo" -[//end]: # "Autogenerated link references" +在`docs`目录下,你可以找到学习Foam一切所需的基础知识。 -## Submitting Issues +## 提交Issues -As you may have noticed, issues are disabled. With the goal to keep the project fairly easy to maintain, please file your issues in the main Foam repository: +您可能已经注意到,Issues已禁用。为了使项目易于维护,请将您的问题提交到主 Foam 存储库中: > diff --git a/todo.md b/todo.md deleted file mode 100644 index f71a016..0000000 --- a/todo.md +++ /dev/null @@ -1,8 +0,0 @@ -# Todo - -You can create todos in Foam. - -- [x] This is an example of a todo list item that's complete -- [ ] This one is not completed yet -- [ ] You can mark it completed by pressing `Option`+`C` (or `Alt`+`C`) when your cursor is on this line - - [ ] You can also select multiple lines and mark them all at once! diff --git a/getting-started.md b/入门指南.md similarity index 81% rename from getting-started.md rename to 入门指南.md index 76297fe..67e8263 100644 --- a/getting-started.md +++ b/入门指南.md @@ -1,20 +1,20 @@ -# Getting Started +# 入门指南 -Welcome to your new foam workspace, let's get you started. +欢迎来到您的新foam工作区,让我们开始吧。 -> if you are already familiar with Foam and don't need help, just remove the `docs` folder for a clean repo. +> 如果您已经熟悉 Foam 并且不需要帮助,只需删除 `docs` 文件夹以获得干净的项目。 -Let's go through this to set up your repo: +让我们通过这个来设置你的仓库: -- [ ] if you are new with VS Code, see how to [[get-started-with-vscode]] and how to [[use-keyboard-shortcuts-for-editing]] +- [ ] 如果你是 VS Code 的新手, see how to [[VS-Code-入门指南]] and how to [[使用快捷键进行编辑]] -- [ ] 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 [[inbox]] +- [ ] 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 [[子弹笔记]] -- [ ] to see how your notes are connected, execute the `Foam: Show Graph` command. See [[graph-visualization]]. +- [ ] to see how your notes are connected, execute the `Foam: Show Graph` command. See [[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-and-tag-explorer]]. +- [ ] #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标签和标签浏览器]]. -- [ ] Foam supports [[spell-checking]]. +- [x] (已经放弃)Foam supports [[拼写检查]] . - [ ] 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]]. diff --git a/inbox.md b/子弹笔记.md similarity index 100% rename from inbox.md rename to 子弹笔记.md diff --git a/待办清单.md b/待办清单.md new file mode 100644 index 0000000..926b4c8 --- /dev/null +++ b/待办清单.md @@ -0,0 +1,8 @@ +# 待办清单 + +你可以在你的Foam中创建待办事项. + +- [x] 这是一项已经被完成的事项的示例 +- [ ] 这一项还没有被完成 +- [ ] 当你的光标在这一行上时,您可以通过按`Option`+`C`(or `Alt`+`C`)将其标记为完成 + - [ ] 您还可以选择多行并一次标记它们!