将 Typedoc 与 aurelia 一起使用

【问题标题】：Using Typedoc with aurelia将 Typedoc 与 aurelia 一起使用
【发布时间】：2017-12-08 23:51:05
【问题描述】：

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

【问题讨论】：

标签： typescript aurelia typedoc

【解决方案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/

【讨论】：