建站指南(Getting Started)
本部分并不是介绍如何从零开始创建一个Docusaurus站。而是介绍如何向Docusaurus站内添加一些官方并不提供的功能。或者提供一些官方虽然提供的功能,但需要通过几个部分的内容组合在一起才能拼凑出如何实现的功能。
如果要从零开始创建一个Docusaurus站请先参考官方文档来搭建一个站点。官方文档:https://docusaurus.io/docs
📄️ 添加lunr本地搜索支持
本文介绍如何向docusaurus中添加搜索支持,搜索支持插件使用docusaurus-lunr-search。并介绍如何增加中文语言支持,以及配置过程中出现的一些问题及问题的处理方案。
📄️ 添加Ant Design UI支持
Docusaurus默认的UI框架为infima,这个UI框架提供的组件并不是特别丰富,如果我们想要使用更多的UI组件,则需要依赖其他UI框架。本文中以Ant Design为例,介绍如何在Swizzling中和MDX文档中使用Ant Design中的组件。
📄️ 添加悬浮按钮
本文介绍如何添加悬浮按钮支持,基于悬浮按钮可以实现返回顶部、打印文档、分享等功能。悬浮按钮的UI需要借助Ant Design,以及Docusaurus的Swizzle。
📄️ 添加返回顶部支持
本文介绍如何在文章中实现返回顶部的功能,需要借助Ant Design的FloatButton(悬浮按钮),和Swizzle。
📄️ 添加打印文档功能
本文介绍如何添加打印文档功能,打印功能并不借助任何第三方库。而是使用css控制。具体实现如下。
📄️ 添加导出为PDF功能
Docusaurus本身并不提供导出为PDF的功能,很多HTML转PDF的工具都无法使用。如:
📄️ 代码块(CodeBlock)显示语言名称
Docusaurus自带的CodeBlock在右上角并不显示代码语言的名称,如果想要显示语言名称则需要使用Swizzling对代码块组件进行修改。