MarkdownEditing 使用教程

MarkdownEditing 使用教程

MarkdownEditing 项目地址: https://gitcode.com/gh_mirrors/mar/MarkdownEditing

项目介绍

MarkdownEditing 是一个为 Sublime Text 2 和 3 设计的 Markdown 编辑插件，旨在提供更好的 Markdown 编辑体验。该插件由 Brett Terpstra 创建，并逐渐发展成为一个社区项目，旨在整合 Sublime Text 中各种 Markdown 包的最佳功能。

MarkdownEditing 提供了丰富的功能，包括语法高亮、自动格式化、列表和块引用的自动处理、Critic Markup 支持等。它还优化了 Sublime Text 的颜色方案，使其更适合编写 Markdown 文档。

项目快速启动

安装

1. 通过 Package Control 安装：

   • 打开 Sublime Text。
   • 按下 Ctrl + Shift + P 打开命令面板。
   • 输入 Install Package 并选择 Package Control: Install Package。
   • 在搜索框中输入 MarkdownEditing，然后选择并安装。

2. 手动安装：

   • 克隆项目仓库到 Sublime Text 的 Packages 目录：

     git clone https://github.com/ttscoff/MarkdownEditing.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/MarkdownEditing
     

基本使用

1. 创建新文件：

   • 打开 Sublime Text，创建一个新文件。
   • 将文件保存为 .md 扩展名，例如 example.md。

2. 编写 Markdown 内容：

   # 标题
   这是一个段落。
   
   - 列表项 1
   - 列表项 2
   
   **加粗文本**
   

3. 预览：

   • 使用 Ctrl + B 或 Cmd + B 在 Sublime Text 中预览 Markdown 文件。

应用案例和最佳实践

案例 1：技术文档编写

MarkdownEditing 非常适合用于编写技术文档。其语法高亮和自动格式化功能可以帮助开发者快速编写和维护文档。例如，编写 API 文档时，可以使用 Markdown 的表格和代码块功能来清晰地展示接口信息和示例代码。

案例 2：博客文章

对于博客作者来说，MarkdownEditing 提供了一个高效的写作环境。通过其自动格式化和快捷键支持，可以快速完成文章的草稿，并通过预览功能实时查看最终效果。

最佳实践

• 使用快捷键：熟练使用 MarkdownEditing 提供的快捷键可以大大提高写作效率。
• 自定义设置：根据个人喜好调整插件的设置，例如修改颜色方案或禁用某些自动功能。

典型生态项目

OmniMarkupPreviewer

OmniMarkupPreviewer 是另一个与 MarkdownEditing 配合使用的 Sublime Text 插件。它允许你在浏览器中实时预览 Markdown 文件的渲染效果，支持代码高亮和其他 Markdown 扩展语法。

安装 OmniMarkupPreviewer

1. 通过 Package Control 安装：

   • 打开命令面板 (Ctrl + Shift + P)。
   • 输入 Install Package 并选择 Package Control: Install Package。
   • 搜索 OmniMarkupPreviewer 并安装。

2. 使用：

   • 在编辑 Markdown 文件时，按下 Ctrl + Alt + O 即可在浏览器中预览。

通过结合使用 MarkdownEditing 和 OmniMarkupPreviewer，你可以获得一个完整的 Markdown 写作和预览解决方案。

MarkdownEditing 项目地址: https://gitcode.com/gh_mirrors/mar/MarkdownEditing