📢 欢迎访问本站!本站持续更新优质内容。哈啊哈

docusaurus精简,去掉blog模式,去掉landing page

📖 本文共 1,738 字,阅读需要 6 分钟

docusaurus精简行动

以下是加入配置代码和示例说明的改写版本:


Docusaurus 精简记录

这次对站点做了两项很直接的精简,目标是减少默认模板残留,让结构更贴近当前使用方式。

1. 去掉 Blog 模式

原本 Docusaurus 的默认能力里包含 Blog,但当前站点并不需要这一块内容,因此直接关闭。

配置修改:docusaurus.config.js

// 精简前
presets: [
  [
    '@docusaurus/preset-classic',
    {
      docs: { /* docs 配置 */ },
      blog: {
        path: 'blog',
        routeBasePath: 'blog',
        postsPerPage: 10,
        // ...其他 blog 配置
      },
      theme: { customCss: require.resolve('./src/css/custom.css') },
    },
  ],
],

// 精简后 —— 直接移除 blog 配置块
presets: [
  [
    '@docusaurus/preset-classic',
    {
      docs: {
        sidebarPath: require.resolve('./sidebars.js'),
        routeBasePath: '/',     // 让文档成为根路径(可选)
      },
      // blog 已完全移除
      theme: { customCss: require.resolve('./src/css/custom.css') },
    },
  ],
],

效果说明:

  • 站点不再生成 /blog 路由
  • 导航栏不再自动出现 Blog 入口
  • 清理 ./blog 目录下示例文章(如有)

这样做的好处有两点:

  • 配置更简单,不再保留无用模块
  • 站点结构更聚焦,避免后续维护时混入无关页面

精简之后,站点主要围绕文档内容组织,不再额外承担博客功能。

2. 不再使用独立 Landing Page

默认的 Landing Page 更像是脚手架演示页,对当前这个文档站来说意义不大。因此首页不再单独维护一个独立页面,而是直接使用某篇文档作为首页。

配置修改:docusaurus.config.js

// 精简前 —— 保留独立的首页组件
presets: [
  [
    '@docusaurus/preset-classic',
    {
      docs: { /* docs 配置 */ },
      theme: { customCss: require.resolve('./src/css/custom.css') },
    },
  ],
],

// 精简后 —— 将 docs 的路由根路径设为 /
presets: [
  [
    '@docusaurus/preset-classic',
    {
      docs: {
        sidebarPath: require.resolve('./sidebars.js'),
        routeBasePath: '/',     // 关键:文档作为根路径
      },
      theme: { customCss: require.resolve('./src/css/custom.css') },
    },
  ],
],

删除/修改的文件:

  • 删除 src/pages/index.js(原独立首页组件)
  • 删除 src/pages/index.module.css(首页样式,如有)
  • 将某篇文档(如 docs/intro.md)设为默认展示的内容

示例:将 docs/welcome.md 作为首页

---
sidebar_position: 1
slug: /           # 关键:此文档路由为根路径
---

# 欢迎使用文档站

这里是精简后的首页,不再有独立的 Landing Page。

效果说明:

  • 用户访问 https://你的域名/ 直接看到 welcome.md 的内容
  • 首页内容与文档体系保持一致
  • 不需要单独维护一套首页组件和样式
  • 用户进入站点后可以直接看到实际内容,而不是过渡页

这种方式更适合以文档为核心的站点,结构更自然,也更省维护成本。

总结

这次精简主要做了两件事:

精简项 配置关键点 代码/文件变动
去掉 Blog 模式 从 preset 中移除 blog 配置块 修改 docusaurus.config.js
删除 ./blog/ 目录(如有)
用文档页作为首页 docs.routeBasePath: '/'
文档 front matter 添加 slug: '/'
修改 docusaurus.config.js
删除 src/pages/index.js
在目标文档中设置 slug: '/'

整体思路很明确:删掉不用的默认能力,减少模板化结构,让 Docusaurus 回到“文档站”本身。

发表评论

您的邮箱地址不会被公开。 必填项已用 * 标注

滚动至顶部