Question

这是我第一次被要求编写文档，而我选择使用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文件？

Answer 1

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

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

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

在tutorials文件夹中，您需要创建尽可能多的.md文件，请记住每个教程都必须具有唯一的名称。

每次您想将某些内容与特定教程（例如称为“ content.md”的教程）连接时，都需要放置

{@tutorial content}

这在Readme.md和您有文档的任何js文件中均可使用。您也可以将一个教程与另一个教程联系起来。

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

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

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

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

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

1 个答案: