Docusaurus 是否支持重命名 'docs' 输出文件夹?

Does Docusaurus support renaming the 'docs' output folder?

我目前正在评估使用 Docusaurus 生成静态网站。该站点本身并不以文档为重点,事实上,该站点甚至与计算机或技术无关。但作为一名技术人员,我想要一个 CI 和 Git 支持的网站发布策略。

Docusaurus 将 Markdown 用于其页面内容(在基于 React 的自定义页面之外)。然而,当这些 Markdown 页面被构建时,它们都被放置在静态站点中名为 docs 的顶级文件夹中。这个文件夹命名与我要制作的网站不符。

customDocsPath 有一个配置设置,但这只会改变构建查找 Markdown 文件的位置,而不是创建的站点内容中的输出路径。

我不是 React 开发人员,但除了将构建引擎中的 JavaScript 修改为 docs 的 search/replace 个实例之外,还有更好的方法吗这个?

我们目前不支持除 /docs 之外的其他路线。有一个 pull request 早在八月份就开始了,但最近又复活了。正在审查和更新 PR 以允许更多可定制的路线。

从 Docusaurus 1.6 开始,现已实现。 pull request 已合并。

找到更多关于此的详细信息 in the site configuration

只需将以下内容添加到 siteConfig.js 中的 siteConfig 部分:

const siteConfig = {
  title: 'My Awesome Site',
  docsUrl: '',
  // ...
};

在 docusaurus 2 中,更改主文档文件夹非常简单:

  • docs/ 重命名为 whatever/

  • 将以下内容添加到 docusaurus.config.js

    presets: [
    [
      '@docusaurus/preset-classic', // should be already there
      {
        docs: {
          path: 'whatever',
          routeBasePath: 'whatever',
    // ...