Question

我必须使用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'
        ]
    }]
}

有什么想法吗？

Answer 1

好的，我自己解决了问题。当我需要一些构建时，我应该像这样创建配置文件：

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

仅此而已：）

TypeDoc来自一个项目的一些文档

1 个答案: