Sublime Text Markdownlint

Markdown/CommonMark文件Sublime Text代码校验插件。

安装

为了使用此插件，您必须安装SublimeLinter。如果没有安装SublimeLinter，请按照以下说明进行操作。

安装Markdownlint

在开始使用此插件之前，您必须确保您的系统上安装了markdownlint。要安装markdownlint，请按以下操作：

1. 安装Node.js。
2. 在终端中输入以下命令来安装markdownlint：

npm install -g markdownlint-cli

1. 如果您使用的是nvm和zsh，请确保加载nvm的行在.zshenv中而不是在.zshrc中。
2. 如果您使用的是zsh和oh-my-zsh，请勿加载oh-my-zsh的nvm插件。

安装Sublime Text Markdownlint

请使用Package Control来安装Sublime Text Markdownlint。这将确保在新版本可用时更新插件。如果您想从源代码安装以便修改源代码，您可能已经知道自己在做什么，所以我们在这里不讨论这一点。

要通过Package Control安装，请执行以下操作：

1. 在Sublime Text中，打开命令面板并输入install。在出现的命令中找到Package Control: Install Package。如果该命令没有高亮显示，请使用键盘或鼠标选择它。Package Control将暂停几秒钟以获取可用的插件列表。

2. 当插件列表出现时，输入markdownlint。在条目中应该看到SublimeLinter-contrib-markdownlint。如果该条目没有高亮显示，请使用键盘或鼠标选择它。

Markdownlint 配置文件

Markdownlint 配置文件（.markdownlintrc）首先根据要检查的文件源目录解析，然后根据用户 $HOME 路径检查。

要指定自定义 Markdownlint 配置路径，在 SublimeLinter 用户设置（SublimeLinter.sublime-settings）中的 linters 下创建一个 markdownlint 部分。然后为 args 添加一个适当的路径到您的 --config 文件。例如

{
    "linters": {
        "markdownlint": {
            "args": ["--config", "/custom/path/to/.markdownlintrc"]
        }
    }
}

贡献

如果您希望提供改进或修复，请按照以下步骤操作

1. 对插件仓库进行分支。
2. 从最新的 master 创建一个单独的主题分支进行修改。
3. 提交并推送主题分支。
4. 发起合并请求。
5. 请耐心等待。

请注意，修改应遵循以下编码指南

• 缩进为 4 个空格。
• 代码应通过 flake8 和 pep257 检查器。
• 垂直空白有助于可读性，请不要害怕使用它。
• 请使用描述性的变量名，除非它们非常知名，否则不要使用缩写。

作者

Jon LaBelle

许可证

MIT 许可证