npm包remark-lint-no-html使用教程

什么是remark-lint-no-html?

remark-lint-no-html 是一个基于 remark-lint 的插件,它可以用于在markdown文档中禁止使用HTML标签。

remark-lint 是一个强大的Markdown风格检查工具,它可以帮助我们规范化和优化 markdown 内容,使其更易读、更好维护。

安装

你可以使用 npmyarn 进行安装:

- -- --- --
--- ------- ---------- --------------------------------------- ------------------ --

- -- ---- --
---- --- ---------- --------------------------------------- ------------------ -----

使用

  1. 创建一个 .remarkrc 文件,并添加以下内容:
-
  ---------- -
    -------- --------------------------
    --------------
    ----------------
  -
-

这里我们使用了 remark-preset-lint-markdown-style-guide 插件来设置一些通用的 Markdown 规则,另外还使用了 remark-frontmatter 插件来支持 Frontmatter.

  1. 在终端上输入以下命令即可对 markdown 文档进行检查:
------ ---------
  1. 如果你想要忽略某些文件的检查,你可以使用以下命令:
------ -------- ------------------- -

其他一些常见的用法:

- -------------
------ ---------

- ---------- -------- ------
------ -

- -------------
------ - -------- ---------

示例代码

以下是一个简单的 Markdown 文档示例:

- ----- -----

-------

-------------- ------ --------------------------

---- -------- ---
-------------
------------------- ---------

HTML 标题

这是一段 HTML 段落。

这是最后一个段落。

-- --------------------- ---------------------------

-------
---- ----- ---- - ---
-----
  -------- -------
  ------- ---- -------
------
---- ------ ---

结论

remark-lint-no-html 插件可以帮助我们在编写 Markdown 内容时避免使用 HTML 标签,以确保我们的内容更加规范化和易读。如果你经常使用 Markdown 进行写作,那么这个插件绝对值得一试。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/49587


猜你喜欢

  • 使用 retext-preset-wooorm 提高文本分析和处理的效率

    retext-preset-wooorm 是一个基于 retext 的 npm 包,可以用于对文本进行语法分析、检查和处理。它包含了多个已经封装好的插件,可以大大提高我们对文本数据的理解和处理效率。

    6 年前
  • npm 包 remark-preset-wooorm 使用教程

    简介 remark-preset-wooorm 是一个强大的 Markdown 处理工具,它基于 remark 和 rehype,提供了一系列方便的插件,可以帮助你更加简单地处理 Markdown 文...

    6 年前
  • npm 包 unified-args 使用教程

    什么是 unified-args? unified-args 是一个用于解析命令行参数的 npm 包,它可以帮助你快速地解析命令行输入,并将其转化为可操作的数据结构。

    6 年前
  • npm 包 remark-cli 使用教程

    简介 remark-cli 是一个使用 remark 库的命令行界面,它可以用来处理、转换和验证 Markdown 文件。remark-cli 可以将 Markdown 文件转换成多种格式,如 HTM...

    6 年前
  • npm 包 esshorten 使用教程

    简介 esshorten 是一个能够将 CSS 和 JavaScript 压缩和简化的 npm 包。压缩和简化这些文件可以提高页面加载速度,减少带宽消耗和用户等待时间。

    6 年前
  • npm 包 wrench 使用教程

    在前端开发中,我们经常需要处理文件操作。如果你正在使用 Node.js 环境,那么可以通过安装 npm 包 wrench 来方便地进行文件操作。 安装 首先,我们需要在项目目录下运行以下命令来安装 w...

    6 年前
  • npm 包 grunt-auto-release 使用教程

    简介 grunt-auto-release 是一个基于 Grunt 的自动化发布工具,它可以自动完成打包、生成 changelog、提交代码、发布到 npm 等流程,大大提高了开发者的工作效率。

    6 年前
  • NPM 包 grunt-npm 使用教程

    简介 grunt-npm 是一个 Grunt 的插件,它可以帮助我们在 Grunt 任务中使用 npm 包管理器。 通过 grunt-npm,我们可以轻松地安装和管理项目依赖项,并将其集成到我们的构建...

    6 年前
  • npm 包 irregular-plurals 使用教程

    在前端开发中,有时需要处理英语单词的复数形式。然而,对于某些特殊的单词,其复数形式可能不按常规变化,这就需要用到 irregular-plurals 这个 NPM 包。

    6 年前
  • npm 包 plur 使用教程

    什么是 Plur? Plur 是一个实用的 npm 包,它可以将英文单词转换为其复数形式。该包使用了 pluralize 库来提供高度可定制化的复数形式转换。 安装 Plur 你可以通过以下命令来安装...

    6 年前
  • npm 包 conventional-changelog-codemirror 使用教程

    介绍 conventional-changelog-codemirror 是一个基于 codemirror 的前端组件,用于生成规范化的 changelog。它支持常见的 commit message...

    6 年前
  • npm 包 conventional-changelog-atom 使用教程

    在前端开发中,版本控制是非常重要的一环。而遵循约定式提交规范(Conventional Commits Specification)则可以为我们的版本管理带来很大的便利性。

    6 年前
  • npm包conventional-changelog-angular使用教程

    在前端开发中,我们经常需要对代码进行版本控制和发布,而这个过程中的changelog就是非常重要的一环。conventional-changelog-angular就是一个帮助我们生成符合Angula...

    6 年前
  • npm 包 conventional-changelog-writer 使用教程

    简介 conventional-changelog-writer 是一个 Node.js 模块,它可以根据 Git 提交信息生成符合 AngularJS Commit Message Conventi...

    6 年前
  • npm 包 git-latest-semver-tag 使用教程

    git-latest-semver-tag 是一个 Node.js 模块,可以帮助我们获取 git 仓库中最新的 semver 标签。本文将介绍如何使用该模块,并且提供详细的代码示例。

    6 年前
  • 通过使用 through2-concurrent 的 npm 包加速文件处理

    当我们需要快速地并行处理大量文件时,Node.js 中的流(stream)非常有用。然而,在处理数千个小文件时,单个进程可能仍然不够快。在这种情况下,通过将处理过程分配给多个子进程来利用多核 CPU ...

    6 年前
  • Mobile Debug-在控制台使用debugger断点调试移动端h5页面的js代码

    Mobile Debug: 使用 Debugger 断点调试移动端 H5 页面的 JavaScript 代码 在移动端开发中,经常会遇到需要调试 JavaScript 代码的情况。

    6 年前
  • npm 包 conventional-commits-detector 使用教程

    背景 在前端开发中,我们通常使用 Git 进行代码管理,并通过提交信息(commit message)记录代码变化。为了更好地管理和理解这些提交信息,出现了 Conventional Commits ...

    6 年前
  • npm 包 conventional-gitlab-releaser 使用教程

    简介 conventional-gitlab-releaser 是一个 Node.js 的命令行工具,用于自动化生成 GitLab 发布日志。它可以根据规范化的 commit message 自动生成...

    6 年前
  • npm 包 gl-got 使用教程

    gl-got 是一个支持 Promise 和 stream 的轻量级 HTTP 请求库,适用于 Node.js 和浏览器端。它是基于 got 构建的,支持在请求中使用缓存和代理等功能。

    6 年前

相关推荐

    暂无文章