docusaurus-plugin 类型道克

A 类 Docusaurus v2 (英语) 用于构建文档的插件 类型文件。 。 。 .

这有什么用?

在Markdown中生成静态的TypeDoc页面,其前题是Docusaurus构建的一部分.

安装

安装 多龙 在您的工程根中,并在 Docuraurus 网站目录的同一位置安装插件依赖性.

npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev

使用量

配置

将插件添加到 docusaurus.config.js 并指定所需选项(见 选项) (中文(简体) ).

module.exports = {
  plugins: [
    [
      'docusaurus-plugin-typedoc',

      // Plugin / TypeDoc options
      {
        entryPoints: ['../src/index.ts'],
        tsconfig: '../tsconfig.json',
      },
    ],
  ],
};

TypeDoc 将用 Docusaurus 绑起靴子 start 财务报告和审定财务报表 build cli 命令数字 :

"start": "docusaurus start",
"build": "docusaurus build",

一旦建成,文件将在 /docs/api (或等同出目录).

目录结构

├── docusauruss-website
    ├── build/ (static site dir)
    ├── docs/
    │   ├── api/ (compiled typedoc markdown)
    ├── docusaurus.config.js
    ├── package.json
    ├── sidebars.js
├──package.json
├──src (typescript source files)
├──tsconfig.json

选项

类型文件选项

要配置类型文件,请通过任何相关的文件 类型文件选项 给配置.

起码 entryPoints 财务报告和审定财务报表 tsconfig 需要设置选项.

entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.json'

需要明确设置额外的类型文件插件 :

plugin: ['typedoc-plugin-xyz'];

其他配置选项

类型Doc 选项也可以声明:

• 使用a typedoc.json 文档.
• 在 typedocOptions 键入 tsconfig.json。 。 。 .

注:以这种方式宣布的选项将具有优先权并覆盖在 docusaurus.config.js。 。 。 .

插件选项

插件特有的选项也应该在同一对象中声明.

示例配置

module.exports = {
  plugins: [
    [
      'docusaurus-plugin-typedoc',
      {
        // TypeDoc options
        entryPoints: ['../src/index.ts'],
        tsconfig: '../tsconfig.json',
        plugin: ['typedoc-plugin-xyz'],

        // Plugin options
        out: 'api-xyz',
        sidebar: {
          categoryLabel: 'API XYZ',
          collapsed: false,
          position: 0,
          fullNames: true,
        },
      },
    ],
  ],
};

食谱

侧边栏和导航栏

边栏

sidebars.js 可用下列方式配置:

1. 从文档文件夹的文件结构( 默认行为) 生成整个侧边栏 :

module.exports = {
  sidebar: [
    {
      type: 'autogenerated',
      dirName: '.', // '.' means the docs folder
    },
  ],
};

2. 或者,如果您想要手动控制侧边栏的其他部分,您可以使用切片来切换类型Doc侧边栏.

注释 : sidebar.categoryLabel, (中文(简体) ), sidebar.collapsed,以及 sidebar.position 选项在此执行中被忽略)

module.exports = {
  sidebar: {
    'Category 1': ['doc1', 'doc2', 'doc3'],
    API: [
      {
        type: 'autogenerated',
        dirName: 'api', // 'api' is the 'out' directory
      },
    ],
  },
};

请看 https://docusaurus.io/docs/ sidebar (中文(简体) ) 用于侧边栏文档.

导航

可以在 themeConfig 选项 docusaurus.config.js数字 :

 themeConfig: {
    navbar: {
      items: [
        {
        to: 'docs/api/',  // 'api' is the 'out' directory
        activeBasePath: 'docs',
        label: 'API',
        position: 'left',
      },
    ],
  },
},

请看 https://docusaurus.io/docs/api/ 主题/configulation#navbar-items 用于导航文档.

前题

默认情况下, 插件将配置所需的最小值 前题 配置 . 此外,在使用全球前题选项时,还可以通过所需的全球前题选项 frontmatter 选项对象

docusaurus.config.js数字 :

plugins: [
    [
      'docusaurus-plugin-typedoc',
      {
      // .... other plugin option
      frontmatter: {
        pagination_prev: null,
        pagination_next: null
      }
    ]
]

多实例

可以通过在多个配置中以独特的 ID 来构建多类型Doc 实例 :

docusaurus.config.js

module.exports = {
  plugins: [
    [
      'docusaurus-plugin-typedoc',
      {
        id: 'api-1',
        entryPoints: ['../api-1/src/index.ts'],
        tsconfig: '../api-1/tsconfig.json',
        out: 'api-1',
      },
    ],
    [
      'docusaurus-plugin-typedoc',
      {
        id: 'api-2',
        entryPoints: ['../api-2/src/index.ts'],
        tsconfig: '../api-2/tsconfig.json',
        out: 'api-2',
      },
    ],
  ],
};

监视模式

通过在 watch: true 选项参见 https://typedoc.org/guides/options/#watch (英语)。 。 。 .

只能使用节点环境变量在开发模式中瞄准选项:

package.json

"start": "TYPEDOC_WATCH=true docusaurus start",
"build": "TYPEDOC_WATCH=false docusaurus build",

docusaurus.config.js

module.exports = {
  plugins: [
    [
      'docusaurus-plugin-typedoc',
      {
        entryPoints: ['../src/index.ts'],
        tsconfig: '../tsconfig.json',
        watch: process.env.TYPEDOC_WATCH,
      },
    ],
  ],
};

Monorepo 设置

docusaurus.config.js

module.exports = {
  plugins: [
    [
      'docusaurus-plugin-typedoc',
      {
        entryPoints: ['../packages/package-a', '../packages/package-b'],
        entryPointStrategy: 'packages',
        sidebar: {
          fullNames: true,
        },
      },
    ],
  ],
};

许可证

麻省理工学院