docusaurus

<div align="center"> <h1 align="center"> Docusaurus <br /> <br /> <a href="https://docusaurus.io"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/859eb4c3-3c42-4954-b9a5-bcbd2485f695.svg" alt="Docusaurus"> </a> </h1> </div> <p align="center"> <a href="https://twitter.com/docusaurus"><img src="https://yellow-cdn.veclightyear.com/835a84d5/0b5e38ba-da02-4d38-80ac-53c9bc5e473b.svg?style=social" align="right" alt="关注Twitter" /></a> <a href="#支持者" alt="Open Collective上的赞助者"><img src="https://yellow-cdn.veclightyear.com/835a84d5/49a27e37-cc60-4c26-812a-46aa115c27f0.svg" /></a> <a href="#赞助商" alt="Open Collective上的赞助商"><img src="https://yellow-cdn.veclightyear.com/835a84d5/1bceedd0-8e1e-4ea0-af2f-1b225f8e5bba.svg" /></a> <a href="https://www.npmjs.com/package/@docusaurus/core"><img src="https://yellow-cdn.veclightyear.com/835a84d5/a173cc0f-fa9a-4082-a2a4-30069c6b0dc2.svg?style=flat" alt="npm版本"></a> <a href="https://github.com/facebook/docusaurus/actions/workflows/tests.yml"><img src="https://yellow-cdn.veclightyear.com/835a84d5/95fe4f1a-af29-4f24-8d0b-e9121df2261f.svg" alt="GitHub Actions状态"></a> <a href="CONTRIBUTING.md#pull-requests"><img src="https://yellow-cdn.veclightyear.com/835a84d5/b324616e-8ce8-4752-9751-1dd616dc903b.svg" alt="欢迎提交PR"></a> <a href="https://discord.gg/docusaurus"><img src="https://yellow-cdn.veclightyear.com/835a84d5/48b30cf8-8d65-467f-b34f-436d0292a068.svg" align="right" alt="Discord聊天" /></a> <a href= "https://github.com/prettier/prettier"><img alt="代码风格：prettier" src="https://yellow-cdn.veclightyear.com/835a84d5/0300bf8a-72ea-4b13-9e26-5aaf90076c7b.svg"></a> <a href="#许可证"><img src="https://yellow-cdn.veclightyear.com/835a84d5/2ed4bfd6-ff6f-4870-8140-66492c35e160.svg?colorB=ff0000"></a> <a href="https://github.com/facebook/jest"><img src="https://yellow-cdn.veclightyear.com/835a84d5/91ab7a72-5b9f-4cff-9bf7-ea63b43a13e5.svg" alt="使用Jest测试"></a> <a href="https://argos-ci.com" target="_blank" rel="noreferrer noopener" aria-label="由Argos覆盖"><img src="https://yellow-cdn.veclightyear.com/835a84d5/5bc4d111-801e-41e3-ae52-7d96650b0c39.svg" alt="由Argos覆盖" width="133" height="20" /></a> <a href="https://gitpod.io/#https://github.com/facebook/docusaurus"><img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod 准备就绪"/></a> <a href="https://app.netlify.com/sites/docusaurus-2/deploys"><img src="https://api.netlify.com/api/v1/badges/9e1ff559-4405-4ebe-8718-5e21c0774bc8/deploy-status" alt="Netlify 状态"></a> </p> <p> <a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ffacebook%2Fdocusaurus%2Ftree%2Fmain%2Fexamples%2Fclassic&project-name=my-docusaurus-site&repo-name=my-docusaurus-site"><img src="https://vercel.com/button" alt="使用Vercel部署"/></a> <a href="https://app.netlify.com/start/deploy?repository=https://github.com/slorber/docusaurus-starter"><img src="https://yellow-cdn.veclightyear.com/835a84d5/314fee4f-4137-411f-b8a0-40cce74c6b01.svg" alt="部署到Netlify"></a> </p> ## 简介

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

贡献者

这个项目的存在要感谢所有做出贡献的人。[贡献]。<a href="https://github.com/facebook/docusaurus/graphs/contributors"><img src="https://yellow-cdn.veclightyear.com/835a84d5/02453adc-c2dd-4dc3-bf26-caf7a8a13f72.svg?width=890&button=false" /></a>

支持者

感谢所有的支持者！🙏 成为支持者

<a href="https://opencollective.com/Docusaurus#backers" target="_blank"><img src="https://yellow-cdn.veclightyear.com/835a84d5/28325de4-39af-46dc-a1c5-5d2d45bda15a.svg?width=890"></a>

赞助商

通过成为赞助商来支持这个项目。你的logo将出现在这里，并链接到你的网站。成为赞助商 <a href="https://opencollective.com/Docusaurus/sponsor/0/website" target="_blank"><img src="https://yellow-cdn.veclightyear.com/835a84d5/384dcb6b-4590-48c8-822e-95a710e92659.svg"></a> <a href="https://opencollective.com/Docusaurus/sponsor/1/website" target="_blank"><img src="https://yellow-cdn.veclightyear.com/835a84d5/83e0fd4b-1e87-4e3b-b88c-53a8106bbfbe.svg"></a>

许可证

Docusaurus 采用 MIT 许可证。

Docusaurus 文档（例如 /docs 文件夹中的 .md 文件）采用 Creative Commons 许可证。

特别感谢

<p> <a href="http://www.browserstack.com/" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="./admin/img/browserstack-dark-mode-logo.svg#gh-dark-mode-only"> <img alt="BrowserStack 标志" src="https://raw.githubusercontent.com/facebook/docusaurus/main/admin/img/browserstack-light-mode-logo.svg#gh-light-mode-only" height="50px" /> </picture> </a> </p>

BrowserStack 为我们提供开源项目免费使用的支持。

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