JSDoc：如何包含多个 .md 文件答案

【问题标题】：JSDoc: How to include multiple .md fileJSDoc：如何包含多个 .md 文件
【发布时间】：2020-07-19 03:58:08
【问题描述】：

这是我第一次被要求编写文档，我选择的方式是使用 jsdoc。

以下是我的 jsdoc 的示例 jsdoc.json 配置文件。它只读取一个 README.md 文件。

{
  "source": {
    "include": "./client/src",
    "includePattern": ".js$",
    "excludePattern": "(node_modules/|docs)"
  },
  "plugins": ["plugins/markdown"],
  "templates": {
    "cleverLinks": true,
    "monospaceLinks": true,
  },
  "opts": {
    "recurse": true,
    "destination": "./docs/",
    "readme": "./README.md"
  }
}

如果我有 index.md 和 content.md，我怎样才能让它读取多个 .md 文件？

【问题讨论】：

标签： node.js reactjs jsdoc jsdoc3

【解决方案1】：

我只是想做同样的功能，我发现的方法并不完美，但效果很好。在 JSDOC 中有一个称为“教程”的功能。

我所做的，是在我的项目文件夹“Tutorials”的根目录中创建的，并在我的配置文件的“opts”部分添加了以下内容：

"opts": {
   "tutorials": "./Tutorials",
}

在教程文件夹中，您可以根据需要创建任意数量的 .md 文件，请记住，每个教程都需要有唯一的名称。

每次您想将某些内容与特定教程（例如名为“content.md”的教程）联系起来时，您需要放置

{@tutorial content}

这适用于 Readme.md 和您拥有文档的任何 js 文件。您还可以将一个教程与另一个教程联系起来。

您可以在此处了解有关该功能的更多信息：

https://jsdoc.app/about-tutorials.html

https://jsdoc.app/tags-inline-tutorial.html

我的回答有点晚了，但我希望这至少可以对你未来的项目有所帮助:)

【讨论】：