Docusaurus 文档服务

515 阅读1分钟

背景

在开发一些项目的时候,有时候需要使用提供业务手册,如何快速低成本的开发和搭建一个文档服务?

方案

Facebook开源了一个Docusaurus(www.docusaurus.cn/) 文档服务脚手架,基于这个脚手架,我们可以快速生成一个文档服务。

image.png

生成文档服务

生成命令:

npx create-docusaurus@latest [name] [template]

例如:

npx create-docusaurus@latest website classic

详细的内容可以参考:www.docusaurus.cn/docs/instal…

使用指南

官网提供了详细的教程,并且有中文版本,上手也非常方便,详情参考:www.docusaurus.cn/docs/catego… image.png

示例

官方提供很多showcase并且带有源码,可以供参考,详情:www.docusaurus.cn/showcase

image.png