什么是remark-lint-no-html?
remark-lint-no-html 是一个基于 remark-lint 的插件，它可以用于在markdown文档中禁止使用HTML标签。
remark-lint 是一个强大的Markdown风格检查工具，它可以帮助我们规范化和优化 markdown 内容，使其更易读、更好维护。
安装
你可以使用 npm 或 yarn 进行安装：
# 使用 npm 安装 npm install remark-cli remark-preset-lint-markdown-style-guide remark-frontmatter -D # 使用 yarn 安装 yarn add remark-cli remark-preset-lint-markdown-style-guide remark-frontmatter --dev
使用
- 创建一个
.remarkrc文件，并添加以下内容：
{
"plugins": [
["lint", ["markdown-style-guide"]],
"frontmatter",
["lint-no-html"]
]
}这里我们使用了 remark-preset-lint-markdown-style-guide 插件来设置一些通用的 Markdown 规则，另外还使用了 remark-frontmatter 插件来支持 Frontmatter.
- 在终端上输入以下命令即可对 markdown 文档进行检查：
remark README.md
- 如果你想要忽略某些文件的检查，你可以使用以下命令：
remark --ignore "node_modules/**/*" .
其他一些常见的用法：
# 指定一个单独的文件进行检查 remark README.md # 指定一个目录下的所有 markdown 文件进行检查 remark . # 将检查结果输出到一个文件中 remark . --output result.md
示例代码
以下是一个简单的 Markdown 文档示例:
-- -------------------- ---- ------- - ----- ----- ------- -------------- ------ -------------------------- ---- -------- --- ------------- ------------------- ---------
HTML 标题
这是一段 HTML 段落。
这是最后一个段落。
-- -------------------- ---- ------- -- --------------------- --------------------------- ------- ---- ----- ---- - --- ----- -------- ------- ------- ---- ------- ------
<!-- 这是一个注释 -->
结论
remark-lint-no-html 插件可以帮助我们在编写 Markdown 内容时避免使用 HTML 标签，以确保我们的内容更加规范化和易读。如果你经常使用 Markdown 进行写作，那么这个插件绝对值得一试。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/49587