介绍
my-doc 是一个 npm 包，提供了快速搭建文档网站的功能。使用 my-doc 可以快速生成静态网站，支持 markdown 格式的文档。
安装
使用 npm，可以在命令行中运行以下命令来安装 my-doc：
npm install -g my-doc
使用
初始化项目
在要创建文档的目录下运行以下命令：
my-doc init
该命令将生成一个 my-doc.yml 文件和一个 src 目录。my-doc.yml 文件是配置文件，src 目录中是存放 markdown 格式文档的目录。
构建
在项目目录下运行以下命令进行构建：
my-doc build
以上命令将在 src 目录中读取 markdown 文件，并将其转换成 HTML 页面，最终生成静态网站。
本地预览
在项目目录下运行以下命令启动本地预览服务器：
my-doc start
然后在浏览器中输入 http://localhost:3000 即可访问预览网站。
配置
在 my-doc.yml 文件中可以进行配置。
-- -------------------- ---- -------
- ----
------ -- --------
- -------- ----- ------------------- - -----------
-------------- ------
- -------
---------- ------
- ----
-------
- ------ ----
----- -
------- -------
- ------ -----
----- ------
------- --------以上代码是一个示例配置文件。
总结
my-doc 是一个极其方便的工具，使用它可以快速生成静态文档网站，为我们的文档撰写和推广工作提供了非常大的帮助。通过本篇介绍，我们对 my-doc 的基本使用方法和常用配置进行了一些简单的说明。希望读者能够通过这篇文章，更好地利用 my-doc 这个工具，优化文档网站。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600668f6d9381d61a3540f0e