29 篇文档带有标签「Docusaurus」

本文介绍如何通过remark-gfm插件实现。Docusaurus自带的Markdown功能没有覆盖GFM的全部功能。如Tasklist功能、删除线等。

本文介绍如何在Markdown中添加mermaid支持，请注意，本文的基础是Docusaurus，此方法仅在Docusaurus中可用。

Docusaurus官方中并没有提供plantuml的支持，因此我们需要添加remark扩展，以此来支持在Markdown中插入plantuml图表。

自定义Admonitions的官方文档：https://docusaurus.io/docs/markdown-features/admonitions#customizing-admonitions

本文介绍如何通过remark-code-import插件实现从文件生成代码块的功能。即不需要在文档中写代码，在写代码块是通过file属性引入代码文件，自动生成代码块。

Markdown中并不支持下划线，但是在写博客或者文档时，我们希望在某些内容下加上下划线，以表示这些内容很重要。

块组件用于在文档中标记处一块高亮区域，可用于表示文档中的重要内容。

Markdown中是不支持设置字体颜色的，如果我们想要在Markdown中设置文字的颜色，一般来说只能使用HTML标签来实现。如下：

将自定义组件注册为全局组件的好处是无需再文档中通过import引入组件，将自定义组件注册为全局组件后可以直接在文档中使用组件。

数学定义用于在文档中插入数学定义。

数学定义用于在文档中插入数学定理。

本组件适用于学习笔记，如听视频课程时，在笔记中记录老师讲的内容，或课件上的内容。使用本组件标识某部分的内容是自己理解的内容，或内容是老师额外补充的内容不是课件上的内容。在《B站宋红康老师JVM笔记》中大量使用了此组件。

答案组件用于在文档中插入习题答案。

配置文档：https://docusaurus.community/knowledge/markdown/definition-lists

安装

Kroki是一个在线服务，支持众多文本生成图像的工具。包括BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag), BPMN, Bytefield, C4 (with PlantUML), D2, DBML, Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, Pikchr, PlantUML, Structurizr, SvgBob, Symbolator, TikZ, UMLet, Vega, Vega-Lite, WaveDrom, WireViz... 等。

参考文档：MDX Plugins

就是玩！本次我们添加一个五线谱的支持。本次我们采用一种不一样的实现。当然也可以直接采用 remark-abcjs 插件来实现，但是我们这次手写一个实现。我们需要借助abcjs这个库来实现

本文介绍如何禁用Blog功能。如果您只想让这个站点作为某个项目的项目文档站，或者只想使用Docusaurus写系列文章，不想在Docusaurus中写博客，可以禁用掉Blog功能。具体实现步骤如下：

Docusaurus自带的CodeBlock在右上角并不显示代码语言的名称，如果想要显示语言名称则需要使用Swizzling对代码块组件进行修改。

Docusaurus默认的UI框架为infima，这个UI框架提供的组件并不是特别丰富，如果我们想要使用更多的UI组件，则需要依赖其他UI框架。本文中以Ant Design为例，介绍如何在Swizzling中和MDX文档中使用Ant Design中的组件。

本文介绍如何向docusaurus中添加搜索支持，搜索支持插件使用docusaurus-lunr-search。并介绍如何增加中文语言支持，以及配置过程中出现的一些问题及问题的处理方案。

Docusaurus本身并不提供导出为PDF的功能，很多HTML转PDF的工具都无法使用。如：

本文介绍如何添加悬浮按钮支持，基于悬浮按钮可以实现返回顶部、打印文档、分享等功能。悬浮按钮的UI需要借助Ant Design，以及Docusaurus的Swizzle。

本文介绍如何添加打印文档功能，打印功能并不借助任何第三方库。而是使用css控制。具体实现如下。

本文介绍如何在文章中实现返回顶部的功能，需要借助Ant Design的FloatButton（悬浮按钮），和Swizzle。

原文地址：https://docs.spring.io/spring-boot/docs/current/reference/html/getting-started.html#getting-started

本文介绍如何配置多个文档，并且每个文档有其自己的版本管理功能。此部分官方文档中有详细说明，但是分布在不同地方。本文将这些内容整理在一起，形成一份完整的指导性文档。

翻译组件