简介
Github-Markdown-Documentation 是一个用于创建基于 Markdown 文件的文档站点的 NPM 包，它可以将 Markdown 文件转换成 HTML/CSS 格式的文档，并提供了一种简单易用的方法来生成文档站点。
安装
全局安装
npm install -g github-markdown-documentation
本地安装
npm install github-markdown-documentation --save-dev
使用方法
初始化文档站点
在项目的根目录下执行以下命令：
gmd init
该命令会在项目根目录下创建一个名为 docs 的文件夹，并在其下面创建一个名为 index.md 的文件，用于作为文档站点的首页。
构建文档站点
在项目根目录下执行以下命令：
gmd build
该命令会将 docs 文件夹下的 Markdown 文件转换成 HTML/CSS 格式的文档，并输出到 docs/_docs 文件夹下，以便于发布到服务器上。
预览文档站点
在项目根目录下执行以下命令：
gmd serve
该命令会启动一个本地服务器，在浏览器中打开 http://localhost:8000 即可预览生成的文档站点。
自定义配置
在项目根目录下创建一个名为 .gmdrc 的文件，并在其中进行配置：
-- -------------------- ---- -------
-
-------- --- ------------- ------
------- --------------
---------- --------------
-------- -----------
-------- ------------------
------------ -----------
----- -----------------
-------- -
-
-------- -------- ---------
----------- -
-
-------- ---------------
------- --------------------
--
-
-------- --------
------- -------------
-
-
--
-
-------- ------
----------- -
-
-------- ------------
------- -----------
-
-
-
-
-注：各配置参数的含义及默认值请参考官方文档。
示例代码
# Getting Started ## Installation To install `github-markdown-documentation`, run the following command:
npm install -g github-markdown-documentation
Alternatively, you can install it locally:
npm install github-markdown-documentation --save-dev
## Usage To generate your documentation site, run the following command:
gmd build
This will generate HTML/CSS formatted documentation and output it to the `_docs` directory. To preview your documentation site, run the following command:
gmd serve
-- -------------------- ---- ------- ---- ---- ----- - ----- ------ --- ---- --- ------------- ---- -- ---- --- -------- - --- -- --------- --- ---- ----- -- ---------- - --- ------------- ----- --- --- --------- --------
gmd init
This will create a `docs` directory and an `index.md` file, which you can edit to create your homepage. ### `gmd build` To build your documentation site, run the following command:
gmd build
This will generate HTML/CSS formatted documentation and output it to the `_docs` directory. ### `gmd serve` To preview your documentation site, run the following command:
gmd serve
This will start a local server and open the documentation site in your web browser. ## License MIT
结语
Github-Markdown-Documentation 是一个相对于其他文档生成工具来说使用简单，并且具有相当好的扩展性、高度可配置的 NPM 包。通过本教程的介绍，您可以方便地上手使用这个工具来生成您的文档站点。希望本教程对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005584381e8991b448d5796