问题标签 [docusaurus]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
630 浏览

javascript - 语法错误:在节点 6 上构建 Docusaurus 时出现意外标记)

docusaurus build在 docusaurus@1.5.1 和节点 6 上运行时遇到错误:

基本上目前在 Docusaurus 中有这样的代码:

我如何解决它?

0 投票
2 回答
926 浏览

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

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

Docusaurus 使用 Markdown 作为其页面内容(在基于 React 的自定义页面之外)。但是,当这些 Markdown 页面构建时,它们都被放置在名为docs. 这个文件夹命名并不真正适合我想要制作的网站。

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

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

0 投票
1 回答
290 浏览

docusaurus - 如何更改 Docusaurus 中的slidingNav 的断点

我的Docusaurus 网站中只有两个标题链接:Docs 和 GitHub。我想让这些链接保留在标题中,直到我将浏览器缩小到 500 像素。不幸的是,一旦浏览器缩小到 1024 像素,链接就会向下滑动。我怎样才能防止这种情况?

我发现以下代码负责滑动导航行为:

但是,如果我将媒体查询的最小宽度更改为 500 像素,则布局会在标题栏下方出现很大间隙:

在此处输入图像描述

更改此断点的正确方法是什么?

0 投票
1 回答
280 浏览

javascript - 如何支持 docusaurus 维护的旧版本文档的更改

我正在尝试创建文档站点的 Docusaurus 工具。到目前为止,一切都还好,直到我来到版本控制

我的理解是:

  1. 您的内容是您下一个版本/docs/**/*.md的最新文档
  2. 您的文档的早期版本在/website/versioned-docs/version-${version-number}目录中可用

我不清楚的是如何维护/发布对以前版本的更改?我的/docs/**目录更改尚未准备好发布。那么,维护旧版本文档更改的机制是什么?

此外,Docusaurus 的文档说明如下:

后备功能

每次指定新版本时,只会复制 docs 目录和侧边栏文件中与最新版本不同的文件。如果版本之间没有变化,Docusaurus 将使用最新版本的文件和该文件。

例如,最新版本 1.0.0 存在原始 id 为 doc1 的文档,并且与 docs 目录中的 id 为 doc1 的文档内容相同。创建新版本 2.0.0 时,不会将 doc1 的文件复制到 versioned_docs/version-2.0.0/。docs/2.0.0/doc1.html 仍然会有一个页面,但它将使用版本 1.0.0 中的文件。

https://docusaurus.io/docs/en/versioning#fallback-functionality

因此,假设我现在需要维护/更新以前版本的文档,但该文件没有重复,因为在创建新版本时,该特定文件没有任何更改。现在,流程是什么?我是否手动将必要的文件复制到/website/versioned-docs/version-${version-number}目录中,然后进行更改?

0 投票
1 回答
644 浏览

hyperlink - 在 GitLab 页面上发布 Docusaurus 网站时如何解决内部链接问题

在我的 Docusaurus 项目中,我的内部链接在我的本地环境中工作,但是当我推送到 GitLab 时,它们不再工作。它没有将原始文档标题替换为新标题,而是将其添加到最后的 url(' https://username.io/test-site/docs/overview/add-a-category.html ')。我查看了我的配置文件,但我不明白为什么会这样。

我尝试更新页面前面的 id,并确保它与 sidebars.json 文件中的 id 匹配。我还添加了 customDocsPath 并在配置文件中将其设置为“docs/”,尽管这应该是默认设置。

我将括号中的添加类别链接更新为 md 扩展名,但这破坏了我本地的链接,它仍然无法在 GitLab 上运行。我希望当用户单击链接时,它将用新的文档标题(' https://username.gitlab.io/docs/add-a-category.html ')替换 url 中的文档标题它只是将它附加到最后(' https://username.gitlab.io/docs/process-designer-overview/add-a-category.html '),因此链接已断开,因为那不是文档所在的位置位于。

0 投票
1 回答
272 浏览

docusaurus - Docusaurus 如何确定侧边栏中标题的顺序?

在我的 Docusaurus 项目中,我在 sidebars.json 中创建了一个新的侧边栏并添加了一些文件,它显示得很好,除了它没有按照我在 json 文件中排序的方式排序。

我的新侧边栏是日期列表以及与这些日期相关的文件。所以我想可能是因为类别是数字。因此,我尝试将它们重命名为带有“当前年份”之类的字母,但这没有用。我也尝试在 Json 文件中重新排列它们,但这也不起作用。

我希望侧导航按照我在 json 文件中的顺序进行排序,但它的顺序与 json 文件中的顺序相反。它不是从 2019 年开始,而是从 2017 年开始。

0 投票
2 回答
426 浏览

javascript - 一次构建静态站点并在多个主机上部署

我想构建我的文档以托管在多个离线环境中,托管在 docker 容器上。这需要静态站点生成器中的以下关键功能,

  • 使用所有资源(js / css),通过静态 html 文件在本地托管。
  • 配置urlbaseUrl在部署时(启动 docker 容器时)。

这两种配置可以帮助实现,构建一次部署在任何地方,并且在离线环境中。

两个问题,

  • 如何在部署时设置 url?
  • 如何将所有资源设置为本地托管?
0 投票
1 回答
128 浏览

docusaurus - 如何在侧边栏中引用作为反应组件编写的页面?

docusaurus 文档描述了如何创建自定义页面作为反应组件。

它还描述了如何将此页面添加到 headerLinks 部分。所以给自定义页面'custom-page.js',我可以将它添加到 headerLinks 中,如下所示:

太棒了 - 这行得通!但是,看在上帝的份上,我该如何将该页面添加到侧边栏配置中呢?我无法在文档中找到任何关于此的内容,并且所有引用该页面的尝试都失败了。是因为没有id吗?我怎样才能给反应组件页面一个 id?

0 投票
1 回答
1954 浏览

javascript - Docusaurus - 如何在新标签页中打开外部链接?

我正在使用 Docusaurus,并希望在新标签中打开外部链接。

我更愿意为此使用代码,而不是按照这个答案在我的降价文档中编写 html 代码的解决方案。

我试过这个答案

[link](url){:target="_blank"}

除了这个答案

[Google](https://google.com" target="_blank)

我认为这篇文章可能会做我想做的事,我尝试将代码添加到 _index.js,但 Docusaurus 停止构建。

我将 JavaScript 代码上传到GitHub并将其添加到siteConfig.js

该脚本似乎已加载,但未按预期工作。

我希望在新的浏览器选项卡中打开一个用 Markdown 编写的链接:

任何想法都会很棒-谢谢

0 投票
2 回答
454 浏览

docusaurus - 有没有办法在 docusaurus 的 docs 目录中排除路径?

我想从docs/目录中排除一个子文件夹来生成文档页面。customDocsPath是一个相关选项,但它是一个字符串。是否有一些未记录的选项可以接受诸如 glob 模式之类的东西?