此项目同步自 facebook / Docusaurus 项目中的 docs. 除特殊情况, 将保持每月一次的同步频率.
Docusaurus 是一个轻松构建,部署和维护开源项目的网站项目。
- 快速起步 Docusaurus 的构建很容易,在尽可能短的时间内 开始并运行 。我们已经打造了 Docusaurus 来处理网站构建过程,以便您可以专注于您的项目。
- 本地化 Docusaurus 通过 CrowdIn 提供 本地化支持。通过翻译文档来增强您的国际社区的地位。
- 可定制 虽然 Docusaurus 带有您需要开始的关键页面和部分,包括主页,文档部分,博客和其他支持页面,但它也是可定制的,以确保您拥有一个独一无二的网站。
Docusaurus 作为 npm 上的 docusaurus
包 来提供。
我们还发布了 docusaurus-init
包 ,来使 Docusaurus 的 入门 更加简单。
- 入门
- 指南
- API
我们发布了 Docusaurus,因为它可以帮助我们更好地扩展和支持 Facebook 上的许多 OSS 项目。 我们希望其他组织也能从这个项目中受益。 我们感谢社区的任何贡献。
Facebook 已经采用了我们期望项目参与者遵守的行为准则。 请阅读全文 ,以便了解哪些行为是不会容忍的。
阅读我们的贡献指南 ,了解我们的开发过程,如何提出错误修正和改进,以及如何构建和测试您对 Docusaurus 的更改。
为了帮助您理解我们的贡献过程,我们列出了一些面向初学者友好的 Bugs,这些 Bugs包含的错误相当容易修复。 这是一个开始的好地方。
Docusaurus 采用 MIT 许可协议.
而 Docusaurus 文档 (例如, /docs
目录下的 .md
文件) 采用 Creative Commons 许可协议.