将Typedoc与aurelia结合使用

Question

我正在尝试在我们的Aurelia项目中使用TypeDoc来创建文档。不幸的是，我们无法生成任何输出，因为TypeDoc无法解析typescript文件中的模块导入。是否有人使用typedoc从Typescript/aurelia项目创建文档？有什么建议吗？

Answer 1

我们将TypeDoc用于我们的Aurelia控制包，它非常简单。NPM脚本如下所示：

"typedoc": "./node_modules/.bin/typedoc --mode modules --tsconfig ./tsconfig.typedoc.json --out documentation --excludePrivate --theme default --readme readme.md ./src"

tsconfig.typedoc.json包含以下内容：

{
    "extends": "./tsconfig.json",
    "files": [
        "src/index.ts"
    ]    
}

你可以在这里查看结果：https://community.sensenet.com/api/sn-controls-aurelia/