带有Markdown的更愉快的写作：棉绒，拼写检查，自动预览等

by Typora.net

发布我的降价文档时，我遇到了一些经常出现的问题，为简单起见，我们将它们称为bug，稍后我将对其进行详细讨论。因此，我决定重新评估我的工作流程。

我个人的喜好是在名为Typora的桌面应用程序中进行写作。它类似于文字处理应用程序，它提供的干扰较少，我喜欢使用其“焦点模式”，具有拼写检查功能以及用于格式化文本的快捷方式。我在博客上使用Jekyll。在将其推送到负责发布的Github之前，我会先在浏览器中进行本地快速浏览。

Typora涵盖了我想要的大部分内容，但是随着时间的流逝，我发现一些语法错误会渗入我的文档中，但我并不总是能发现。因此，某种绒毛会很好。我还希望一些其他功能，例如添加目录（TOC），任何手动编写有点繁琐且容易出错的功能。

理想情况下，我将使用一个应用程序执行所有操作，但实际上只有在配置了适合自己喜好的IDE时，才有可能在一个应用程序中获得所需的一切。

我将为我解释什么是“无错误”发布，以及哪些工具可用来帮助改善降价文档的质量。

TLDR

我配置VSCode使其更接近于“无错误”的发布理想。我继续将Typora用于草稿，并使用VSCode进行最终编辑和发布！

“无错误”发布

当您将markdown转换为HTML并将其推送到您想要发布的任何位置时，“无错误”发布可确保不会有意外或不良的结果。以下是您可能要包含在工作流程中的一些任务：

  1. 语法检查（删除）。确保降价是正确的。应用程序没有此功能，您需要使用带有linting插件的IDE或任务运行器。
  2. 拼写检查。默认情况下，大多数应用程序都具有拼写检查功能，而大多数IDE则没有。
  3. 在各处使用相同的markdown语法。没有说降价和其相关的变种语法之间和你的目标平台使用引擎盖下太大的区别，但它是好是你在你看到预览之间是一致的。我想在 任何地方使用Github风格的markdown。
  4. 保存时格式化。您可能需要对文档使用自动格式设置，以消除严重的格式设置错误并确保一致性。
  5. 检查图像的有效性。这特定于我的设置。我注意到，我使用的编辑器和Jekyll（我的静态站点生成器）对文件路径的期望不同。例如，看下面图片中的文件夹，如果我想将image banner.png嵌入我的markdown文件中，大多数应用程序都希望../img/banner.png，Jekyll希望/img/banner.png。我希望我的编辑器和静态网站生成器同意。博客文件夹
  6. 生成TOC和部分编号。减少手工创建和维护这些。

工具类

我将快速列出一些您可能想在编辑器之外使用的工具的选项，或者作为您在编辑器中的集成使用的选项（如果可能）。它们可以用作CLI工具，任务运行器， github动作 或某些IDE的插件。

林亭

  1. MarkdownLint：样式检查器和整理工具，提供几种语言和不同的集成。
  2. Textlint：通过许多集成提供降价和自然语言提示 。

拼写检查

  1. markdown-spellcheck：读取markdown文件并对其进行拼写检查。它使用开源的Hunspell词典文件。用JavaScript编写，可在npm上使用。

为您的所有降价需求配置VSCode

VSCode对Markdown具有不错的“开箱即用”支持。VSCode在其文档中对此进行了介绍： VSCode和Markdown。

“开箱即用”功能

  1. 支持CommonMark Markdown规范。
  2. 实时预览。您可以打开活动降价文档的实时预览。
  3. 预览和编辑器滚动同步。如果要查看降价和并排预览，可以使它们一致滚动。
  4. 轮廓图。它显示了文档标题层次结构的符号树。
  5. 没有拼写检查。

我想要的其他功能

  1. 支持Github风格的Markdown规范。
  2. 整理（代码分析）
  3. 拼写检查
  4. Markdown的另一个主题可以视觉提醒我我处于不同的环境中。
  5. 自动生成目录和章节编号。减少手工创建和维护这些。

我的配置

我决定使用以下扩展：

  1. Markdown All in One用于：支持GitHub的Markdown，创建目录，节编号，键盘快捷键和自动完成功能。
  2. markdownlint用于整理和进行某些格式化。我喜欢选择何时自行解决违规问题。
  3. 保存时更漂亮的格式化。如果支持，这将根据语言设置代码块的格式。还有很多！
  4. 主题按语言 设置，仅针对降价设置特定主题。
  5. 拼写 检查正确。
vscode markdown编辑

在“问题”选项卡中：拼写问题列为错误，而棉绒问题列为警告。

我的用户设置（settings.json）

{

   ...

  "[markdown]": {
    "breadcrumbs.showClasses": true,
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "markdownlint.config": {
    "default": true,
    "MD003": {
      "style": "atx"
    },
    "MD010": {
      "code_blocks": false
    },
    "MD026": {
      "punctuation": ".,;:"
    },
    "MD033": false
  },
  "theme-by-language.themes": {
    "markdown": "Markdown Editor",
    "*": "Monokai"
  }
}

最后的话

在诸如Microsoft Word和OpenOffice Writer之类的文字处理器中，您理所当然地认为许多功能可以帮助您精心编写和格式化格式的散文。Markdown的应用程序没有相同的丰富功能集，您还需要遵守语法。

我发现调整工作流程以保持愉快的写作体验，同时提高输出质量是一项值得的投资。我仍然在这里和那里进行调整。


Tags: ,