# [Docusaurus](https://docusaurus.io) ·  [![CircleCI](https://circleci.com/gh/facebook/Docusaurus.svg?style=svg)](https://circleci.com/gh/facebook/Docusaurus) [![npm version](https://badge.fury.io/js/docusaurus.svg)](https://badge.fury.io/js/docusaurus) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md#pull-requests)

> 此项目同步自 [facebook](https://github.com/facebook) / [Docusaurus](https://github.com/facebook/Docusaurus) 项目中的  docs. 除特殊情况, 将保持每月一次的同步频率.

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

* **快速起步** Docusaurus 的构建很容易，在尽可能短的时间内 [开始并运行](docs/getting-started-installation.md) 。我们已经打造了 Docusaurus 来处理网站构建过程，以便您可以专注于您的项目。
* **本地化** Docusaurus 通过 CrowdIn 提供 [本地化支持](docs/guides-translation.md)。通过翻译文档来增强您的国际社区的地位。
* **可定制** 虽然 Docusaurus 带有您需要开始的关键页面和部分，包括主页，文档部分，[博客](docs/guides-blog.md)和其他支持页面，但它也是[可定制](docs/guides-custom-pages.md)的，以确保您拥有一个[独一无二](docs/api-pages.md)的网站。

## 安装

Docusaurus 作为 [npm](https://www.npmjs.com) 上的 [`docusaurus` 包](https://www.npmjs.com/package/docusaurus-init) 来提供。

我们还发布了 [`docusaurus-init` 包](https://www.npmjs.com/package/docusaurus-init) ，来使 Docusaurus 的 [入门](https://docusaurus.io/docs/en/installation.html) 更加简单。

## 文档目录
* 入门
  * [安装指南](docs/getting-started-installation.md)
  * [准备网站](docs/getting-started-preparation.md)
  * [创建网站](docs/getting-started-site-creation.md)
  * [发布网站](docs/getting-started-publishing.md)
* 指南
  * [添加博客](docs/guides-blog.md)
  * [自定义页面](docs/guides-custom-pages.md)
  * [启用搜索](docs/guides-search.md)
  * [导航和侧边栏](docs/guides-navigation.md)
  * [翻译 & 本地化](docs/guides-translation.md)
  * [版本化](docs/guides-versioning.md)
* API
  * [CLI 命令](docs/api-commands.md)
  * [Markdown 功能](docs/api-doc-markdown.md)
  * [页面和样式](docs/api-pages.md)
  * [siteConfig.js](docs/api-site-config.md)

## 贡献

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

### [行为守则](https://code.facebook.com/codeofconduct)

Facebook 已经采用了我们期望项目参与者遵守的行为准则。 请阅读[全文](https://code.facebook.com/codeofconduct) ，以便了解哪些行为是不会容忍的。

### 贡献指南

阅读我们的[贡献指南](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md) ，了解我们的开发过程，如何提出错误修正和改进，以及如何构建和测试您对 Docusaurus 的更改。

### 面向初学者友好的 Bugs

为了帮助您理解我们的贡献过程，我们列出了一些[面向初学者友好的 Bugs](https://github.com/facebook/Docusaurus/labels/good%20first%20issue)，这些 Bugs包含的错误相当容易修复。 这是一个开始的好地方。

### 许可协议

Docusaurus 采用 [MIT 许可协议](https://github.com/facebook/Docusaurus/blob/master/LICENSE).

而 Docusaurus 文档 (例如, `/docs` 目录下的 `.md` 文件) 采用 [Creative Commons 许可协议](https://github.com/facebook/Docusaurus/blob/master/LICENSE-docs).