作为前端开发者，我们经常需要编写文档来记录项目的重要信息。然而，手动编写文档往往是一项耗时且乏味的任务。而 md-docs-express 就是一款方便易用的 npm 包，能够帮助我们快速生成漂亮的 Markdown 文档。本文将介绍如何安装和使用 md-docs-express 。
安装
运行以下命令安装 md-docs-express ：
--- ------- ---------------
快速上手
安装完成后，我们需要创建一个简单的 Express 应用程序，代码如下：
----- ------- - ------------------ ----- --- - --------- ---------------- ----------------------------- ---------------- -- -- -------------------- --- --------- -- ---- --------
上面的代码创建了一个 Express 应用程序，使用了 md-docs-express 作为中间件。use()方法中的第一个参数 /docs 是公开文档的 URI，可以根据需要进行调整。
配置
为了自定义 md-docs-express 的行为，我们可以传递一些选项作为参数：
---------------- ------------------------------------
其中 options 可以是以下属性：
| Property | Type | Description |
|---|---|---|
source |
string |
Markdown 文件的文件夹路径。默认值为 ./docs 。 |
base |
string |
在文档中链接的基本 URL。默认值为 /docs 。 |
title |
string |
文档的标题。默认值为 Documentation 。 |
favicon |
string |
用作网站图标的文件路径。默认值为 null。 |
version |
string |
用于显示文档版本的文本。默认值为 null。 |
theme |
string |
用于自定义文档主题的文件夹路径。默认值为 ./theme。 |
highlight |
string |
代码语法高亮库的名字。 默认值为 highlight.js。 |
这里我们可以将 title,source和highlight属性传递给选项。
---------------- ---------------------------- ------ --- --- --------------- ------- ------------ ---------- ---------- ---
示例
接下来，我们为 md-docs-express 创建一个示例文档来测试我们的应用程序。
首先，创建一个新的 Markdown 文件并将其保存在我们选择的文档资源目录中。下面是一个简单的示例文件：
- ------- -- -- --- ------------- -- ------- ------- --- ------------- ------ --- ------ ---- ---- --- ---- --- --------- ----- ---------- - ------- - --- --- ------------ ------- --- ------- ----- ----
npm i my-api
-- ----- ------------- ----- ----- - ----------------- -------------------
--------------------- ---- -------------------------- ------------ ----------------- -------------------------------------------------------------------------------------------- -------------------------- --------------- ------ -------- --- -- -- ---- --------------------------- -------- --------------------------- ------------------------------------------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------