Docusaurus 是一个用于轻松构建、部署和维护开源项目网站的项目。
时间不够?来看看我们的5分钟教程⏱️!
提示:使用docusaurus.new可以在 playground 中立即测试 Docusaurus。
- 入门简单
Docusaurus 的设计旨在尽可能快速地投入使用。我们开发 Docusaurus 的目的是为了处理网站构建过程,让您可以专注于您的项目本身。
- 本地化
Docusaurus 通过 CrowdIn 提供本地化支持。通过翻译您的文档,赋能并发展您的国际社区。
- 可定制
Docusaurus 附带了您入门所需的关键页面和部分,包括主页、文档部分、博客和其他支持页面,同时它也是可定制的,以确保您拥有一个独一无二的网站。
使用初始化 CLI 创建您的网站:
npm init docusaurus@latest
请阅读文档以获取更多信息。
我们发布 Docusaurus 是因为它有助于我们更好地扩展规模,并支持 Meta 的众多开源项目。我们希望其他组织也能从该项目中受益。我们感谢社区的任何贡献。
Meta制定了一套行为准则,我们希望项目参与者遵守。请阅读全文,以便了解哪些行为将被容忍,哪些行为将被禁止。
阅读我们的贡献指南,了解我们的开发流程、如何提出错误修复和改进建议,以及如何构建和测试您对 Docusaurus 的更改。
为了帮助您快速上手并熟悉我们的贡献流程,我们列出了一些适合新手解决的 bug,这些 bug 可能包含一些较小的问题。这是一个很好的起点。