讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在 Docusaurus 构建过程中排除指定文件夹?

风婷姑娘_1262

风婷姑娘_1262

发布时间:2026-05-14 18:07:02

|

235人浏览过

|

来源于php中文网

原创

如何在 Docusaurus 构建过程中排除指定文件夹?

在 Docusaurus 中,可通过配置 @docusaurus/plugin-content-pages 的 exclude 选项,精准控制哪些路径不参与生产构建(如开发专用文档),同时保留在开发环境可访问,实现环境差异化路由管理。

在 docusaurus 中,可通过配置 `@docusaurus/plugin-content-pages` 的 `exclude` 选项,精准控制哪些路径不参与生产构建(如开发专用文档),同时保留在开发环境可访问,实现环境差异化路由管理。

Docusaurus 默认会将 src/pages/(或 docs/ 等内容目录)下的所有 Markdown/JSX 文件自动注册为页面。即使你从侧边栏(sidebar)中移除了某个子文件夹的链接,其页面仍可能通过直接 URL 访问——这在生产环境中存在安全与维护风险。真正有效的解决方案是在构建阶段彻底排除该路径。

✅ 正确做法:使用 plugin-content-pages 的 exclude 配置

@docusaurus/plugin-content-pages(Docusaurus v2+ 内置插件)支持 exclude 字段,接收正则表达式数组,匹配的路径将完全跳过页面生成和路由注册(包括 SSR 和客户端导航)。

以你的情况为例:假设开发专用文件夹为 src/pages/dev-only/,希望仅在生产构建(docusaurus build)中排除,而开发服务器(docusaurus start)中保留以便调试:

// docusaurus.config.js
module.exports = {
  // ... 其他配置
  plugins: [
    [
      '@docusaurus/plugin-content-pages',
      {
        path: 'src/pages',
        exclude: process.env.NODE_ENV === 'production' 
          ? [/^dev-only\//]  // 匹配 src/pages/dev-only/ 下所有文件
          : [],
      },
    ],
  ],
};

? 注意正则写法:路径匹配基于 src/pages/ 下的相对路径(不含 src/pages/ 前缀)。例如 src/pages/dev-only/guide.md 对应匹配路径为 dev-only/guide.md,因此 /^dev-only\// 是准确的。

⚠️ 关键注意事项

  • exclude 仅作用于 plugin-content-pages 管理的页面(即 src/pages/ 及其子目录),不适用于 docs/ 目录;若需排除 docs/ 下的文件,请改用 @docusaurus/preset-classic 中 docs 插件的 exclude 选项:

    presets: [
      [
        '@docusaurus/preset-classic',
        {
          docs: {
            exclude: process.env.NODE_ENV === 'production' 
              ? ['dev-guide/**'] // 支持 glob 模式(v2.4+)
              : [],
          },
        },
      ],
    ],
  • 排除后,对应 URL 将返回 404(生产环境),且不会出现在任何静态 HTML 输出或路由映射中,彻底杜绝意外访问。

  • 若使用自定义 path(如 path: 'content/pages'),请确保正则匹配的是该自定义路径下的相对路径。

✅ 验证方式

  1. 运行 NODE_ENV=production npm run build,检查输出日志是否不再出现 dev-only/xxx 相关页面构建记录;
  2. 打开生成的 build/ 目录,确认无 dev-only/ 对应的 HTML 文件;
  3. 在本地 build/ 静态服务中访问 /dev-only/,应返回 404;
  4. 对比 npm run start 时仍可正常访问该路径,验证环境区分生效。

通过此方案,你既能保持开发调试便利性,又能确保生产站点干净、安全、符合文档发布规范。

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

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

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

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

3409

2023.06.20

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

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

2388

2023.07.25

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

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

1320

2023.08.02

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

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

1258

2023.08.09

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

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

1396

2023.09.05

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

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

2278

2023.09.20

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

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

3700

2023.09.20

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

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

17135

2023.09.22

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

60

2026.10.22

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn