使用jsdoc内联渲染'.md'文件?

时间:2020-09-24 03:01:16

标签: jsdoc

typedoc可以通过在注释中链接markdown文件来使生成的文档内嵌'.md',如下所示:

/*
 * [[include:example.md]]
 */
function myFunction() {
}

see typedoc docs here

我正在寻找一种在jsdoc中模拟此行为的方法。通过jsdoc注释中的名称引用markdown文件并将其内联显示在jsdoc输出的生成的html中的任何方法。

Jsdoc具有教程的概念,其中可以将markdown文件链接到注释中,但不能呈现markdown。它只是提供了一个可点击的链接。也许有一个呈现而不是链接的jsdoc模板?

我已经看到了这个问题: JSDoc: How to include multiple .md file。 我正在寻找比使用jsdoc教程更好的解决方案。

0 个答案:

没有答案