问题标签 [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.
javascript - 将 JS 代码片段(全文、混合面板等)添加到 Docusaurus.io
我正在尝试找出如何添加 JS 代码片段以使用 Docusaurus.io ( https://docusaurus.io )。我想在我的基于 Docusaurus 的 Web 文档中添加一些分析工具,例如 - mixpanel、完整故事等,但我不知道该怎么做。
javascript - react-native 文档是如何制作的?
我知道代码在这里:https://github.com/facebook/react-native-website
它使用 Docusaurus,但是,降价是从代码自动生成的,还是全部手动编写的?
如果它是自动生成的,使用的是什么?
escaping - 降价表中的竖线符号
Markdown 表使用竖线作为字段分隔符,但我需要在某些单元格中写一个竖线。这可能吗?我正在使用 GFM(GitHub 风味的 Markdown)。
我可以以某种方式逃脱垂直条吗?
这不在 GitHub 上,而是通过 Docusaurus。我不知道 Docusaurus 使用哪个解析器,但以下都不起作用:
|
-|
只是被显示(&
被转义)<code>
- 显示任何 html(<
被转义)\|
-|
仍然充当表格单元格分隔符
更新:
|
如果我在反引号中没有它,则可以使用。所以,至少现在,我只是取消了竖线的反引号。例如,a | b
变成a
|b
docusaurus - 访问 sidebars.json (docusaurus) 中未列出的文档时显示侧边栏
我注意到,当我访问不在 sidebars.json 内的文档时,左侧边栏不会显示,但是如果我添加此文档是否显示 JSON,我希望左侧边栏可见,即使是 id 文档我正在访问的未在此 JSON 文件中列出
javascript - 区分 docusaurus 中的页面/内容
虽然 docusaurus 提供对文档(页面/文档)的内容/结构的完全控制,但此控制嵌入在不受控制的 (DOM) 父级中。
例如,如果我想对整个页面使用不同的填充,但只针对索引页面,除了使用 javascript 更改值之外,我没有办法这样做。
有没有办法以某种方式将文档 ID 插入 DOM,例如:
还是class=
取而代之?
或者,我有没有其他方法可以为特定页面编写特定的 css 规则或 js 逻辑?
docusaurus - Docusaurus 中的自定义登录页面
我有一个工作任务,就是实现 Docusaurus 里面的登录页面。
我正在尝试index.js
通过添加一些HelloWorld
. 包括 login.js
哪些有实际的 Docusaurus 索引页面
但抛出的错误是:
Error: Cannot find module './login.js'
js
是否可以从Docusaurus的另一个页面调用课程?
reactjs - 将带有模板脚本的 HTML 添加到 Docusaurus (React) 页面
我需要将包含模板脚本的自定义 HTML 添加到 Docusaurus 站点(基于 React),但该站点没有 .html 文件 - 只有 .js 文件,然后编译这些文件以创建静态站点。具体来说,我需要添加一个包含<script type="text/template"></script>
块的 .html 文件,这意味着我不能像普通的 HTML 元素那样使用 React/JSX 来渲染它。
到目前为止,这是我的尝试,这导致页面上显示一个文字字符串,其中包含我的<script type="text/template"></script>
块的内容:
Footer.js
如果我不使用fs
并设置
运行时出现以下错误npm start
:
这就是我使用fs
.
这是resultsTemplate.html
,我想将其注入页脚:
最后,这是应该使用正确值填充模板的函数(取自 Algolia):
有关更多上下文,我正在尝试在我的站点中实现此功能:https ://jsfiddle.net/965a4w3o/4/
algolia - 在 Docusaurus 页面中为 Instantsearch.js 部分使用 Algolia Docsearch 索引
我有一个使用 Docusaurus.io 构建的文档站点,并且正在使用 Docsearch 作为我在导航栏中的搜索 - 这工作正常。但是,我也想在网站的登录页面上实现 Algolia 即时搜索。该代码在使用 Instantsearch 设置的旧索引上运行良好,但是当我将新 Docsearch 索引的 API 密钥和 ID 插入到 Instantsearch 配置函数中时,我得到了一个我无法理解的 JSON 对象流.
这是我正在尝试使用的模板(它适用于 Jekyll 网站上的旧索引):
这导致空白<div>
。
当没有应用模板时,我的结果以嵌套 JSON 对象的形式返回。
我试图实现的是一个额外的即时搜索,它只出现在文档网站的主页上。据我了解,我在 Docsearch 中不能有两个输入选择器,这就是我一直尝试使用 Instantsearch 的原因。我需要一个适用于 Docsearch API 返回数据的方式的模板。
github-pages - 每次构建后删除 Docusaurus CNAME 文件
我正在使用 Docusaurus 构建一个具有自定义域名并由 GitHub 页面托管的网站,一切正常。但是在我运行docusaurus-build
CNAME 文件后被删除。导致我的网站无法从我的自定义域访问。
我尝试重新添加 CNAME 文件并不能帮助它在每次构建后被删除。
我知道 docusaurus 替换了构建目录中的所有文件,但是如何防止它删除我的 CNAME 文件?
我的 siteConfig 文件如下所示:
现在我的解决方案是在我的存储库中重新配置我的 GitHub 页面设置,所以其他人会遇到同样的问题吗?