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

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中有一个称为"教程"的功能。

我所做的，是在我的项目文件夹"教程"的根目录上创建的，并添加到我的配置文件中的"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

我的回答有点晚了，但我希望这至少能对你未来的项目有所帮助：(