使用Typedoc和aurelia

Question

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

Answer 1

我们在Aurelia Control软件包中使用TypeDoc，它非常简单。 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/