docusaurus - Docusaurus 是一个用于轻松构建、部署和维护开源项目网站的项目。

Created at: 2017-06-21 00:13:53
开发语言: TypeScript
授权协议: MIT

多克萨龙

多克萨龙

推特 关注 npm 版本 GitHub 操作状态 欢迎公关 不和谐聊天 代码风格: 更漂亮 通过开玩笑测试 Gitpod Ready-to-Code 网络化状态 CI 分数 使用 Vercel 进行部署 部署到 Netlify

我们正在努力开发Docusaurus v2。如果你不熟悉 Docusaurus,请尝试使用新版本而不是 v1。有关更多详细信息,请参阅 Docusaurus v2 网站

Docusaurus v1 doc 可在 v1.docusaurus.io,代码可在 branch docusaurus-v1 上找到。

介绍

Docusaurus是一个用于轻松构建,部署和维护开源项目网站的项目。

时间紧迫?查看我们的5分钟教程⏱️

提示:使用 docusaurus.new 立即在操场上测试 Docusaurus。

  • 易于启动

Docusaurus的构建方式使其可以在尽可能短的时间内运行。我们已经建立了Docusaurus来处理网站构建过程,因此你可以专注于你的项目。

  • 可本地化

Docusaurus通过CrowdIn提供本地化支持。通过翻译你的文档,增强你的国际社区的能力并发展你的国际社区。

  • 定制

虽然 Docusaurus 附带了入门所需的关键页面和部分,包括主页、文档部分、博客和其他支持页面,但它也是可自定义的,以确保你拥有一个独一无二的网站。

安装

使用初始化 CLI 创建站点:

npm init docusaurus@latest

阅读文档以获取更多信息。

贡献

我们发布了Docusaurus,因为它可以帮助我们更好地扩展并支持Facebook的许多OSS项目。我们希望其他组织也能从该项目中受益。我们感谢社区的任何贡献。

行为准则

Facebook 已经通过了一项行为准则,我们希望项目参与者遵守该准则。请阅读全文,以便了解哪些行为将被容忍,哪些行为不会被容忍。

贡献指南

阅读我们的贡献指南,了解我们的开发过程,如何提出错误修复和改进建议,以及如何构建和测试你对 Docusaurus 的更改。

初学者友好的错误

为了帮助你弄湿脚步并熟悉我们的贡献流程,我们列出了初学者友好的错误,其中可能包含需要首先解决的小问题。这是一个开始的好地方。

联系

我们有几个联系方式:

  • 不和谐
    • #general
      对于那些使用Docusaurus的人。
    • #contributors
      对于那些想要为Docusaurus核心做出贡献的人来说。
  • 特上的@docusaurus
  • GitHub 问题

贡献

这个项目的存在要感谢所有做出贡献的人。[贡献]。

支持者

感谢我们所有的支持者!🙏 成为支持者

赞助商

通过成为赞助商来支持这个项目。你的徽标将显示在此处,并带有指向你网站的链接。成为赞助商

许可证

Docusaurus是 MIT 的许可

Docusaurus文档(例如,文件夹中的文件)是知识共享许可的

.md
/docs

特别鸣谢

浏览器堆栈徽标

BrowserStack支持我们免费访问开源

火箭验证器徽标

Rocket Validator帮助我们找到HTML标记或可访问性问题。