69

0

Docusaurus

Docusaurus 是一款静态站点生成器。 可以搭建带有快速客户端导航的单页应用,充分利用了 React,让你的网站具有交互能力。 它提供了开箱即用的文档功能,不过也可用于搭建各种网站(个人网站、产品、博客、营销主页,等等)。

Docusaurus

推特关注 npm 版本 GitHub 操作状态 公关欢迎 不和谐聊天代码风格:更漂亮 用 Jest 测试 Gitpod 准备编码 网络化状态 CI 分数 使用 Vercel 进行部署 部署到 Netlify

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

Docusaurus v1 文档可在v1.docusaurus.io 获得,代码可在分支docusaurus-v1获得

介绍

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

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

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

  • 简单上手

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

  • 可本地化

Docusaurus 通过 CrowdIn 提供本地化支持。通过翻译您的文档来增强和发展您的国际社区。

  • 可定制

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

安装

使用初始化 CLI 创建您的站点:

npm init docusaurus@latest

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

贡献

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

行为守则

Facebook 采用了我们希望项目参与者遵守的行为准则。请阅读全文,以便您了解哪些行为会被容忍,哪些行为不会被容忍。

投稿指南

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

初学者友好的错误

为了帮助您了解并熟悉我们的贡献过程,我们提供了一个适合初学者的错误列表,其中可能包含需要首先解决的较小问题。这是一个开始的好地方。