如何在 Docusaurus 中排除指定文件夹参与构建

夜明同学_5905

夜明同学_5905

2026-05-14

632人浏览

原创

如何在 Docusaurus 中排除指定文件夹参与构建

docusaurus 默认会将 src/pages/ 下所有 .mdx 或 .jsx 文件作为页面处理,可通过 @docusaurus/plugin-content-pages 的 exclude 配置项精准排除特定路径,实现开发环境可访问、生产构建不打包的灵活控制。

docusaurus 默认会将 src/pages/ 下所有 .mdx 或 .jsx 文件作为页面处理,可通过 @docusaurus/plugin-content-pages 的 exclude 配置项精准排除特定路径,实现开发环境可访问、生产构建不打包的灵活控制。

在 Docusaurus 2 中,页面内容由 @docusaurus/plugin-content-pages 插件统一管理。即使你已从侧边栏(sidebar)中移除了某个子目录的链接,只要该目录下存在合法页面文件(如 dev-notes/index.mdx),它仍会在 docusaurus build 时被编译并输出到 build/ 目录中,并可通过直接 URL 访问——这不符合“仅用于开发”的设计意图。

✅ 正确做法是:利用插件原生支持的 exclude 选项,按构建环境动态过滤路径。你只需在 docusaurus.config.js 的 plugins 或 presets 对应配置中添加 exclude 字段:

// docusaurus.config.js
module.exports = {
  // ... 其他配置
  presets: [
    [
      '@docusaurus/preset-classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        pages: {
          exclude: process.env.NODE_ENV === 'production' 
            ? [/^\/dev-notes\//, /\/src\/pages\/dev-notes\//] 
            : [],
        },
        // 其他 preset 配置(docs, blog 等)
      }),
    ],
  ],
};

⚠️ 注意事项:

  • 正则表达式需匹配路由路径(URL path),而非文件系统路径。例如,若 dev-notes/index.mdx 生成的路由为 /dev-notes/,则应匹配 /^\/dev-notes\//;
  • 若页面位于 src/pages/ 下(如 src/pages/dev-notes/index.mdx),其默认路由即为 /dev-notes/,无需额外配置 routeBasePath;
  • exclude 作用于插件解析阶段,早于路由注册和静态生成,因此被排除的文件不会出现在 HTML 输出中,也无法通过任何 URL 访问(生产环境);
  • 开发服务器(docusaurus start)中保持 exclude: [],确保调试顺畅;
  • 不要依赖 sidebar 隐藏或 .gitignore 来规避构建——它们均不影响页面打包逻辑。

? 进阶提示:你也可结合 process.env.DOCUSAURUS_ENV 自定义环境变量,或使用 fs.existsSync() 动态判断路径是否存在,进一步增强配置鲁棒性。最终目标是让文档站点专注交付,而开发资产真正“隐身”于生产构建之外。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2809

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2168

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1140

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1078

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1296

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2018

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3120

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

13775

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

529

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习