Skip to content

常用编辑器配置

不同的编辑器对 Markdown 的支持程度不同,通过适当的配置可以提升 Markdown 的编辑体验。在本章中,我们将介绍常用编辑器的 Markdown 配置方法。

VS Code 配置

推荐插件

  • Markdown All in One:提供 Markdown 编辑的各种功能,如自动列表、表格格式化、快捷键等。
  • Markdown Preview Enhanced:增强的 Markdown 预览功能,支持数学公式、图表、代码块等。
  • Markdownlint:Markdown 语法检查工具,帮助你保持 Markdown 文档的一致性。
  • Code Spell Checker:拼写检查工具,帮助你发现 Markdown 文档中的拼写错误。
  • Markdown Table Prettifier:表格格式化工具,帮助你美化 Markdown 表格。

配置示例

在 VS Code 的 settings.json 文件中添加以下配置:

json
{
  "[markdown]": {
    "editor.wordWrap": "on",
    "editor.quickSuggestions": {
      "comments": "off",
      "strings": "off",
      "other": "off"
    }
  },
  "markdown.preview.style": "github",
  "markdown.preview.breaks": true,
  "markdownlint.config": {
    "default": true,
    "MD007": {
      "indent": 2
    },
    "MD013": false,
    "MD033": false
  }
}

快捷键

  • Ctrl+Shift+V:打开 Markdown 预览
  • Ctrl+B:加粗选中文本
  • Ctrl+I:斜体选中文本
  • Ctrl+K V:在侧边栏打开 Markdown 预览

Sublime Text 配置

推荐插件

  • MarkdownEditing:Markdown 编辑增强,提供语法高亮、自动完成等功能。
  • MarkdownPreview:Markdown 预览功能,在浏览器中预览 Markdown 文档。
  • MarkdownLint:Markdown 语法检查工具。
  • Table Editor:表格编辑工具,帮助你编辑 Markdown 表格。
  • SmartMarkdown:Markdown 编辑增强,提供自动列表、链接等功能。

配置示例

在 Sublime Text 的用户设置中添加以下配置:

json
{
  "font_size": 14,
  "tab_size": 2,
  "translate_tabs_to_spaces": true,
  "word_wrap": true,
  "wrap_width": 80,
  "rulers": [80],
  "draw_white_space": "all",
  "trim_trailing_white_space_on_save": true,
  "ensure_newline_at_eof_on_save": true
}

快捷键

  • Ctrl+Shift+P:打开命令面板,输入 "MarkdownPreview: Preview in Browser" 预览 Markdown 文档
  • Ctrl+Alt+P:在新窗口中预览 Markdown 文档
  • Tab:缩进列表项
  • Shift+Tab:减少缩进

Vim/Emacs 配置

Vim 配置

推荐插件

  • vim-markdown:Markdown 语法高亮和编辑增强。
  • vim-pandoc:Markdown 编辑增强,支持 Pandoc。
  • vim-table-mode:表格编辑工具,帮助你编辑 Markdown 表格。

配置示例

~/.vimrc 文件中添加以下配置:

vim
" Markdown 配置
filetype plugin on
syntax on

" 自动换行
set wrap
set linebreak
set textwidth=80

" 缩进
set tabstop=2
set shiftwidth=2
set expandtab

" 启用 markdown 插件
let g:markdown_fenced_languages = ['html', 'python', 'javascript', 'css', 'bash']
let g:markdown_syntax_conceal = 0

快捷键

  • gf:跳转到链接指向的文件
  • Ctrl+]:跳转到标题
  • Ctrl+t:返回上一个位置

Emacs 配置

推荐插件

  • markdown-mode:Markdown 编辑模式。
  • pandoc-mode:Pandoc 集成。
  • org-mode:可以导出为 Markdown。

配置示例

~/.emacs.d/init.el 文件中添加以下配置:

elisp
;; Markdown 配置
(use-package markdown-mode
  :ensure t
  :mode ("README\\.md\\'" . gfm-mode)
  :init (setq markdown-command "pandoc")
  :config
  (setq markdown-content-type "text/html"
        markdown-css-path "https://cdn.jsdelivr.net/npm/github-markdown-css@4.0.0/github-markdown.min.css"
        markdown-xhtml-header-content "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">"
        markdown-hide-urls t)
  (add-hook 'markdown-mode-hook 'visual-line-mode)
  (add-hook 'markdown-mode-hook 'flyspell-mode)
  (add-hook 'markdown-mode-hook 'auto-fill-mode))

快捷键

  • C-c C-c p:在浏览器中预览 Markdown 文档
  • C-c C-c e:导出 Markdown 文档
  • M-RET:在列表中插入新项

其他编辑器配置

Typora 配置

Typora 是一款所见即所得的 Markdown 编辑器,配置相对简单:

  1. 偏好设置

    • 打开 Typora,点击 "文件" -> "偏好设置"
    • 在 "编辑器" 选项卡中,可以设置字体、字号、行高���
    • 在 "Markdown" 选项卡中,可以设置 Markdown 语法偏好
  2. 主题

    • 在 "外观" 选项卡中,可以选择内置主题或安装自定义主题
    • 支持自定义 CSS 样式
  3. 导出

    • 在 "导出" 选项卡中,可以设置导出格式和选项

Atom 配置

推荐插件

  • markdown-preview-plus:增强的 Markdown 预览功能。
  • linter-markdown:Markdown 语法检查工具。
  • autocomplete-paths:路径自动完成,方便插入图片和链接。
  • markdown-table-editor:表格编辑工具,帮助你编辑 Markdown 表格。

配置示例

在 Atom 的配置文件中添加以下配置:

json
{
  "*": {
    "editor": {
      "fontSize": 14,
      "tabLength": 2,
      "softTabs": true,
      "wordWrap": "on",
      "wrapLength": 80
    }
  },
  "markdown-preview-plus": {
    "useGitHubStyle": true,
    "breakOnSingleNewline": true
  }
}

Visual Studio 配置

Visual Studio 也支持 Markdown 编辑:

  1. 安装插件

    • 在 Visual Studio 中,点击 "工具" -> "扩展和更新"
    • 搜索并安装 "Markdown Editor" 扩展
  2. 配置

    • 安装完成后,重启 Visual Studio
    • 打开 Markdown 文件时,会自动使用 Markdown 编辑器

通用配置建议

字体和字号

  • 字体:选择等宽字体,如 Consolas、Monaco、Courier New 等
  • 字号:根据个人喜好设置,一般 14-16px 较为合适
  • 行高:设置适当的行高,提高可读性

缩进和换行

  • 缩进:使用 2 或 4 个空格作为缩进
  • 换行:启用自动换行,设置合适的换行宽度
  • 空格:在句子之间使用单个空格,在标点后使用单个空格

拼写检查

  • 启用拼写检查功能,避免拼写错误
  • 自定义词典,添加专业术语和常用词汇

自动保存

  • 启用自动保存功能,避免意外丢失内容
  • 设置合理的自动保存间隔

小结

通过适当的编辑器配置,可以提升 Markdown 的编辑体验,提高写作效率。不同的编辑器有不同的配置方法,你可以根据自己的喜好和需求进行配置。

在接下来的附录中,我们将介绍 Markdown 与其他格式的转换方法。