Docusaurus 是一个用于轻松构建、部署和维护开源项目网站的项目。
时间紧迫?看看我们的 5 分钟教程⏱️!
提示:使用docusaurus.new立即在操场上测试 Docusaurus。
Docusaurus 的构建方式使其可以在尽可能短的时间内运行。我们构建了 Docusaurus 来处理网站构建过程,以便您可以专注于您的项目。
Docusaurus 通过 CrowdIn 提供本地化支持。通过翻译您的文档来增强和发展您的国际社区。
虽然 Docusaurus 附带了您开始使用所需的关键页面和部分,包括主页、文档部分、博客和其他支持页面,但它也可以自定义,以确保您拥有一个独一无二的网站。
使用初始化 CLI 创建您的站点:
npm init docusaurus@latest
阅读文档以获取更多信息。
我们发布了 Docusaurus,因为它可以帮助我们更好地扩展并支持 Meta 上的许多 OSS 项目。我们希望其他组织能够从该项目中受益。我们感谢社区的任何贡献。
Meta 已采用我们希望项目参与者遵守的行为准则。请阅读全文,以便您了解哪些行为是可以容忍的,哪些行为是不能容忍的。
阅读我们的贡献指南,了解我们的开发流程、如何提出错误修复和改进,以及如何构建和测试对 Docusaurus 的更改。
为了帮助您入门并熟悉我们的贡献流程,我们提供了一系列适合初学者的错误,其中可能包含需要首先解决的较小问题。这是一个很好的起点。
我们有几个联系渠道:
#general
对于那些使用 Docusaurus 的人。#contributors
适合那些想要为 Docusaurus 核心做出贡献的人。这个项目的存在要感谢所有做出贡献的人。 [贡献]。
感谢我们所有的支持者!成为支持者
成为赞助商来支持该项目。您的徽标将显示在此处,并带有指向您网站的链接。成为赞助商
Docusaurus 已获得 MIT 许可。
Docusaurus 文档(例如, /docs
文件夹中的.md
文件)已获得知识共享许可。
BrowserStack 支持我们免费访问开源代码。
Rocket Validator 帮助我们发现 HTML 标记或可访问性问题。