VSCode Markdown Notes 使用教程

VSCode Markdown Notes 使用教程

项目介绍

VSCode Markdown Notes 是一个为 Visual Studio Code 设计的扩展，旨在提供类似于 Bear、Roam 等应用的笔记管理功能。该扩展支持使用 [[wiki-links]]、#tags 和 @bibtex-citations 进行快速导航，自动从新的内联 [[wiki-links]] 创建笔记，并提供语法高亮、自动完成、定义跳转等功能。

项目快速启动

安装

1. 打开 Visual Studio Code。
2. 进入扩展市场，搜索 Markdown Notes。
3. 点击安装。

配置

在 VSCode 中打开设置，添加以下配置：

{
  "markdownNotes.enableWikiLinks": true,
  "markdownNotes.wikiLinkFileNameCase": "caseInsensitive",
  "markdownNotes.newNoteDirectory": "sameFolder"
}

使用

1. 创建一个新的 Markdown 文件。
2. 使用 [[wiki-links]] 创建链接。
3. 使用 #tags 和 @bibtex-citations 进行标记。

示例代码：

# 我的笔记

这是一个示例笔记，包含一个链接 [[另一个笔记]] 和一个标签 #示例。

应用案例和最佳实践

案例一：学术研究笔记

使用 @bibtex-citations 功能，可以方便地引用学术文献，例如：

根据 @Smith2020 的研究，Markdown 笔记有助于提高学术写作效率。

案例二：项目管理

使用 #tags 功能，可以对笔记进行分类管理，例如：

# 项目计划

## 任务一 #开发
- 完成模块 A 的开发 [[模块A开发]]

## 任务二 #测试
- 进行模块 A 的测试 [[模块A测试]]

最佳实践

• 使用 [[wiki-links]] 进行内部链接，提高笔记间的关联性。
• 使用 #tags 进行分类，便于快速检索。
• 定期整理笔记，删除不再需要的链接和标签。

典型生态项目

Markdown All In One

提供 Markdown 编辑所需的所有功能，包括快捷键、自动预览、格式化等。

Markdownlint

帮助检查和修正 Markdown 文件中的格式问题，确保文档的一致性和可读性。

Live Server

用于实时预览 Markdown 文件的 HTML 输出，方便调试和展示。

vscode-pdf

在 VSCode 中直接打开 PDF 文件，便于查阅相关文档。

通过这些扩展的组合使用，可以大大提高 Markdown 笔记的编辑和管理效率。