【问题标题】:Does Docusaurus support renaming the 'docs' output folder?Docusaurus 是否支持重命名“文档”输出文件夹?
【发布时间】:2018-11-26 15:47:28
【问题描述】:

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

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

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

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

【问题讨论】:

    标签: docusaurus


    【解决方案1】:

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

    【讨论】:

    • 如果 PR 发布,我会更新这个问题,谢谢!
    【解决方案2】:

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

    更多详情请见in the site configuration

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

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

    【讨论】:

      【解决方案3】:

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

      • docs/ 重命名为whatever/

      • 将关注添加到docusaurus.config.js

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

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2014-09-09
        • 2014-07-25
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多