如何在Docusaurus中禁用‘My Site’首页并直接展示教程页？

1. 删除默认首页文件 #

Docusaurus的默认首页对应src/pages/index.js（或index.tsx），直接删除这个文件，默认的“My Site”首页就会消失。

2. 将教程页面设为网站根路径 #

修改docusaurus.config.js中的presets配置，把文档路由设为根路径，并指定你的“How to Use”文档作为首页：

presets: [
  [
    '@docusaurus/preset-classic',
    {
      docs: {
        routeBasePath: '/', // 将docs目录设为网站根路径
        homePageId: 'how-to-use', // 对应教程文档的文件名（去掉.md后缀）
        sidebarPath: require.resolve('./sidebars.js'),
      },
      blog: false, // 不需要博客功能可直接关闭
      theme: {
        customCss: require.resolve('./src/css/custom.css'),
      },
    },
  ],
],

3. 配置教程文档的显示优先级 #

在你的“How to Use”文档（比如docs/how-to-use.md）顶部添加元数据，确保它在侧边栏中优先显示：

---
sidebar_position: 1
title: How to Use
---

// 你的教程内容

4. （可选）调整导航栏配置 #

如果导航栏里还有指向原首页的链接，修改themeConfig.navbar.items，替换为教程页面的入口：

themeConfig: {
  navbar: {
    title: '你的文档标题',
    items: [
      {
        type: 'doc',
        docId: 'how-to-use',
        position: 'left',
        label: 'How to Use',
      },
      // 其他导航项
    ],
  },
},

注意事项 #

修改配置后必须重启Docusaurus开发服务（停止npm run start后重新启动），否则新配置不会生效。

内容的提问来源于stack exchange，提问作者Onur Güleçoğlu