npm 包 gitdown 使用教程

简介

gitdown 是一个基于 Markdown 的文档生成工具，可以将 GitHub 上的 markdown 文件转换为可执行的、动态的文档。使用 gitdown 可以帮助前端开发人员更方便地管理和生成文档，并且支持在文档中添加 JavaScript 代码片段和自定义组件。

安装

可以通过 npm 安装 gitdown，打开终端并输入以下命令：

npm install -g gitdown

使用

1. 配置文件

在项目根目录下新建一个名为 gitdown.config.js 的配置文件，该文件用来配置 gitdown 的相关信息（例如：文档存放位置、自定义组件等）。示例配置如下：

module.exports = {
  input: './docs',
  output: './public',
  components: {
    MyButton: './components/MyButton'
  }
}

• input：指定需要生成文档的文件夹路径；
• output：指定文档生成后的输出路径；
• components：自定义组件的配置，这里配置了一个名为 MyButton 的组件，其路径为 ./components/MyButton。

2. Markdown 文件

编写符合 GitHub Flavored Markdown 规范的 markdown 文件，并在其中添加 JavaScript 代码片段和自定义组件。例如：

# Hello World

这是一个简单的示例：

<MyButton>点击我</MyButton>

```javascript
console.log('Hello World');

3. 生成文档

在终端中输入以下命令生成文档：

gitdown

文档将会在配置文件指定的输出路径下生成，可以通过浏览器打开查看。

总结

使用 gitdown 可以让前端开发人员更方便地管理和生成文档，并且支持在文档中添加 JavaScript 代码片段和自定义组件。可以根据需要进行个性化的配置和扩展。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/41322