VS Code — 开发者首选编辑器
内置功能
Ctrl+Shift+V（Mac:⌘⇧V）：打开 Markdown 预览面板Ctrl+K V：侧边打开预览（与编辑器并排）- 内置 Markdown 语法高亮
推荐扩展
| 扩展 | 功能 |
|---|---|
| Markdown All in One | 自动补全、格式化、目录生成、快捷键 |
| Markdown Preview Enhanced | 增强预览、Mermaid、数学公式、导出 PDF |
| markdownlint | 实时语法检查，提示不规范写法 |
| Paste Image | 粘贴图片自动保存并插入 Markdown 语法 |
| Foam | 双向链接知识库，类 Obsidian 体验 |
常用快捷键（Markdown All in One）
| 快捷键 | 功能 |
|---|---|
| Ctrl+B / ⌘B | 加粗选中文字 |
| Ctrl+I / ⌘I | 斜体选中文字 |
| Alt+Shift+F | 格式化 Markdown（含表格对齐） |
| Ctrl+Shift+[ / ] | 增加/减少标题级别 |
Pandoc — Markdown 转换神器
Pandoc 是通用文档转换工具，可以将 Markdown 转换为几乎任何格式：
# 安装 brew install pandoc # macOS apt install pandoc # Ubuntu winget install pandoc # Windows # Markdown → HTML pandoc README.md -o README.html # Markdown → PDF（需要 LaTeX 环境） pandoc README.md -o README.pdf # Markdown → Word pandoc README.md -o README.docx # Markdown → 幻灯片（Reveal.js） pandoc slides.md -t revealjs -s -o slides.html # 批量转换 for f in docs/*.md; do pandoc "$f" -o "out/${f%.md}.html"; done
TIPPandoc 支持 YAML front matter 设置元数据（标题、作者、日期等），在转换 PDF 和 Word 时会自动应用到文档属性中。
MkDocs — Python 文档站
MkDocs 将一组 Markdown 文件构建成静态文档网站：
# 安装 pip install mkdocs mkdocs-material # 创建项目 mkdocs new my-project cd my-project # 本地预览（热重载） mkdocs serve # 构建静态网站 mkdocs build # 部署到 GitHub Pages mkdocs gh-deploy
mkdocs.yml 配置示例
site_name: 我的文档
site_url: https://example.com
theme:
name: material
language: zh
palette:
primary: indigo
nav:
- 首页: index.md
- 安装指南: install.md
- API 参考:
- 概述: api/overview.md
- 端点: api/endpoints.md
Docusaurus — React 文档站
Facebook 开源的文档框架，适合大型项目文档：
# 创建项目 npx create-docusaurus@latest my-docs classic # 启动开发服务器 cd my-docs npm start # 构建 npm run build
特色功能
- 支持 MDX（Markdown + JSX React 组件）
- 内置版本管理（多版本文档共存）
- 国际化（i18n）支持
- Algolia 搜索集成
- 插件系统（博客、重定向、PWA 等）
Obsidian — 个人知识库
基于 Markdown 的本地知识管理工具，支持双向链接：
核心特性
- 双向链接：
[[文件名]]创建链接，自动生成关系图谱 - 本地优先：所有文件存储为普通 .md 文件，无供应商锁定
- 插件生态：500+ 社区插件（Dataview、Tasks、Calendar 等）
- Canvas：白板功能，可视化整理笔记
Obsidian 特有语法
# 双向链接 [[笔记名称]] [[笔记名称|显示文字]] [[笔记名称#章节]] # 嵌入其他笔记 ![[其他笔记名称]] # 标签 #工作 #项目/后端 # Callout（告警块） > [!note] 标题 > 内容
Typora — 所见即所得编辑器
输入 Markdown 语法后立即渲染，无需分屏预览，对写作者非常友好：
- 实时渲染，写什么看什么
- 支持主题切换（GitHub、Academic 等）
- 支持导出 PDF、HTML、Word、EPUB
- 内置 Mermaid 和 LaTeX 支持
- 付费软件（一次性买断，~15 美元）
markdown-link-check — 链接有效性检查
# 安装 npm install -g markdown-link-check # 检查单个文件 markdown-link-check README.md # 在 GitHub Actions 中自动检查
name: Check Links
on: [push, pull_request]
jobs:
check-links:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gaurav-nelson/github-action-markdown-link-check@v1
小结
- VS Code + Markdown All in One 是开发者最推荐的写作环境
- Pandoc 是 Markdown 格式转换（PDF/Word/HTML）的利器
- MkDocs（Python）和 Docusaurus（React）是最流行的文档站框架
- Obsidian 适合个人知识管理，支持双向链接和本地存储