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

cle*_*mon 5 docusaurus

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

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

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

我不是 React 开发人员,但除了在构建引擎中破解 JavaScript 来搜索/替换 的实例之外docs,还有更好的方法吗?

Cez*_*wak 10

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

  • 重命名docs/为whatever/

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

    presets: [
    [
      '@docusaurus/preset-classic', // should be already there
      {
        docs: {
          path: 'whatever',
          routeBasePath: 'whatever',
    // ...
    
    Run Code Online (Sandbox Code Playgroud)


小智 2

我们目前不支持/docs- 以外的路线。有一个拉取请求早在八月份就开始了,但最近又被复活了。PR 正在接受审查和更新,以允许更多可定制的路线。