[英]TypeDoc a few documentations from one project
我必須使用TypeDoc來准備項目的文檔。
在我的項目中,我有幾個包含TS文件的文件夾(彼此無關),例如。 文件夾A,文件夾B等
當我只想要一個或多個文件夾中的一個文檔時,我非常簡單,但是很難為每個文件夾生成單獨的文檔。
對於一個文件夾,我的配置文件如下所示:
typedoc: {
build: {
options: {
module: 'commonjs',
out: '../Documentation/A',
name: 'Documentation for A folder',
target: 'es5',
exclude: '**/*.d.ts',
excludePrivate: true,
mode: 'file'
},
src: [
'js/A/*.ts'
]
}
}
如果我想為每個文件夾創建單獨的文檔,我不知道應該如何構建此配置。
我嘗試了類似的構建數組(但沒有成功):
typedoc: {
build: [{
options: {
module: 'commonjs',
out: '../Documentation/A',
name: 'Documentation for A folder',
target: 'es5',
exclude: '**/*.d.ts',
excludePrivate: true,
mode: 'file'
},
src: [
'js/A/*.ts'
]
},
{
options: {
module: 'commonjs',
out: '../Documentation/B',
name: 'Documentation for B folder',
target: 'es5',
exclude: '**/*.d.ts',
excludePrivate: true,
mode: 'file'
},
src: [
'js/B/*.ts'
]
}]
}
有任何想法嗎?
好,我自己解決了問題。 當我需要一些構建時,我應該像這樣創建配置文件:
typedoc: {
buildA: {
options: {
module: 'commonjs',
out: '../Documentation/A',
name: 'Documentation for A folder',
target: 'es5',
exclude: '**/*.d.ts',
excludePrivate: true,
mode: 'file'
},
src: [
'js/A/*.ts'
]
},
buildB: {
options: {
module: 'commonjs',
out: '../Documentation/B',
name: 'Documentation for B folder',
target: 'es5',
exclude: '**/*.d.ts',
excludePrivate: true,
mode: 'file'
},
src: [
'js/B/*.ts'
]
}
}
我應該這樣稱呼它:
typedoc:buildA
要么
typedoc:buildB
就這樣 :)
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.