Docusaurus
made with React

Docusaurus

这是一个轻松维护的开源文档网站框架。

简介及使用教程

Docusaurus是一个易于构建、部署和维护开放源代码项目网站框架,易用并在尽可能短的时间内启动和运行。

Docusaurus还附带了本地化支持以及支持自定义获取的关键页面和部分,确保用户拥有一个独一无二的网站。

Docusaurus由Markdown提供支持,并使用React构建。

特点

  • 支持 Markdown
  • 基于 React 技术构建
  • 支持文档多语言翻译
  • 文档版本化
  • 内容可搜索

安装

npx @docusaurus/init@next init [name] [template]

例如

npx @docusaurus/init@next init my-website classic

项目结构

my-website
├── blog
│   ├── 2019-05-28-hola.md
│   ├── 2019-05-29-hello-world.md
│   └── 2020-05-30-welcome.md
├── docs
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   └── mdx.md
├── src
│   ├── css
│   │   └── custom.css
│   └── pages
│       ├── styles.module.css
│       └── index.js
├── static
│   └── img
├── docusaurus.config.js
├── package.json
├── README.md
├── sidebars.js
└── yarn.lock

运行

cd my-website
npm run start
#或者
yarn run start

构建

npm run build
#或者
yarn run build

示例

image.png

image.png

image.png

image.png

作者

Facebook

@facebook

相关项目

这是一个用于使用React构建可访问的富Web应用程序的工具包。
这是一个仪表板生成器。
这是一个具有GraphQL API的产品信息管理(PIM)系统。
这是一个React代码库生成器。
这是一个支持自定义样式的在线微信Markdown排版工具。
这是一个官方的创建React 应用程序的工具。