Docusaurus 是一个用于轻松构建、部署和维护开源项目网站的工具。
时间紧迫?查看我们的5分钟教程 ⏱️!
提示:使用 docusaurus.new 立即在playground中测试Docusaurus。
- 简单上手
Docusaurus 的设计理念是让你能够快速开始。我们开发 Docusaurus 来处理网站构建过程,让你可以专注于你的项目。
- 本地化支持
Docusaurus 通过 CrowdIn 提供本地化支持。通过翻译你的文档来扩大和发展你的国际社区。
- 可定制化
虽然 Docusaurus 提供了你开始所需的关键页面和部分,包括主页、文档部分、博客和其他支持页面,但它也是可定制的,以确保你拥有一个独一无二的网站。
安装
使用初始化CLI创建你的网站:
npm init docusaurus@latest
查看文档以获取更多信息。
贡献
我们发布 Docusaurus 是因为它帮助我们更好地扩展并支持 Facebook 的许多开源项目。我们希望其他组织也能从这个项目中受益。我们感谢来自社区的任何贡献。
行为准则
Facebook 已采用一套行为准则,我们希望项目参与者能够遵守。请阅读全文,以了解哪些行为会被允许,哪些行为不会被容忍。
贡献指南
阅读我们的贡献指南,了解我们的开发流程、如何提出错误修复和改进建议,以及如何构建和测试你对 Docusaurus 的更改。
适合初学者的bugs
为了帮助你入门并熟悉我们的贡献流程,我们有一个适合初学者的bugs列表,其中可能包含一些较小的问题,可以先尝试解决。这是一个很好的开始点。
联系方式
我们有几个联系渠道:
- Discord:
#general
频道适合 Docusaurus 用户。#contributors
频道适合想为 Docusaurus 核心贡献的人。
- Twitter 上的 @docusaurus
- GitHub Issues
贡献者
这个项目的存在要感谢所有做出贡献的人。[贡献]。
支持者
感谢所有的支持者!🙏 成为支持者
赞助商
通过成为赞助商来支持这个项目。你的logo将出现在这里,并链接到你的网站。成为赞助商
许可证
Docusaurus 采用 MIT 许可证。
Docusaurus 文档(例如 /docs
文件夹中的 .md
文件)采用 Creative Commons 许可证。
特别感谢
BrowserStack 为我们提供开源项目免费使用的支持。
Rocket Validator 帮助我们发现 HTML 标记或可访问性问题。