有没有办法排除 docusaurus 中 docs 目录中的路径？

Question

我想从生成文档页面中排除

docs/

目录中的子文件夹。

customDocsPath

是一个相关选项，但它是一个字符串。是否有任何未记录的选项可以接受类似全局模式的东西？

Answer 1

我可以通过指定

@docusaurus/preset-classic (@docusaurus/plugin-content-docs)

插件的配置来排除它。

https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs

presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          exclude: ['**/any/dir/**'],
        },
      },
    ],
  ],

我用

v2beta.9

测试过。

Answer 2

要正式回答您的问题，不，Docusaurus V1 中没有这样做的选项。

我们不太可能将其添加到 V1 中，但我们很乐意在 V2 中支持该功能，并在前面添加一个

draft

选项，以便它会在开发过程中显示，但不会在生产版本中显示。

Answer 3

您只需转到您的

ducusaurus.config.file

并添加并设置预设/文档

routeBasePath: '/'

  presets: [
     [
          'classic',
          /** @type {import('@docusaurus/preset-classic').Options} */
          ({
            docs: {
              routeBasePath: '/',

更多信息：https://docusaurus.io/docs/advanced/routing

Answer 4

您还可以使用

_

启动文件夹或文件。

根据文档：

_

目录下所有带有下划线（

docs

）前缀的文件都被视为“部分”页面，默认会被忽略。

很可能您需要将此类文件夹包含到

.gitignore

中。