docusaurus README

The project's README from github.com/facebook/docusaurus. As one markdown file: README.md.

Docusaurus

Docusaurus

Twitter Follow npm version GitHub Actions status PRs Welcome Discord Chat code style: prettier Tested with Jest Covered by Argos Gitpod Ready-to-Code Netlify Status Deploy with Vercel Deploy to Netlify

Introduction

Docusaurus is a project for building, deploying, and maintaining open source project websites easily.

Short on time? Check out our 5-minute tutorial ⏱️!

Tip: use docusaurus.new to test Docusaurus immediately in a playground.

Docusaurus is built in a way so that it can get running in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project.

Docusaurus ships with localization support via CrowdIn. Empower and grow your international community by translating your documentation.

While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a blog, and additional support pages, it is also customizable to ensure you have a site that is uniquely yours.

Installation

Use the initialization CLI to create your site:

npm init docusaurus@latest

Read the docs for any further information.

Contributing

We've released Docusaurus because it helps us better scale and supports the many OSS projects at Meta. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.

Code of Conduct

Meta has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.

Beginner-friendly bugs

To help you get your feet wet and get you familiar with our contribution process, we have a list of beginner-friendly bugs that might contain smaller issues to tackle first. This is a great place to get started.

Contact

We have a few channels for contact:

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 Become a backer

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor

License

Docusaurus is MIT licensed.

The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.

Special thanks

BrowserStack logo

BrowserStack supports us with free access for open source.

Rocket Validator logo

Rocket Validator helps us find HTML markup and accessibility issues.

docusaurus (facebook/docusaurus)

Searching Database…

66.5K ·GitHub
Docusaurus
这是什么？Docusaurus 是一个让你轻松搭建、部署和维护开源项目网站的工具，它负责网站的构建流程，让你可以专注于项目本身。
它是在线托管的服务，还是我自己在本地运行的？它是一个静态网站生成器框架：你在自己的电脑上运行它来编写内容并构建网站，然后把生成的网站部署出去。
我怎么创建第一个网站？使用初始化命令行工具来创建你的网站。如果不想安装任何东西就想先试试，可以打开 docusaurus.new 在线演练场，或者跟着 5 分钟教程走一遍。
创建网站之前需要装好什么？你需要 Node.js：Docusaurus 是基于 JavaScript 和 TypeScript 的工具链（代码库本身要求 Node >=24.14 和 pnpm >=12.3.4）。
Docusaurus 只是给 Meta 自己的项目用的，还是任何人都能用？任何人都可以用。Meta 开源它，是因为它能帮他们扩展和维护众多开源项目，也希望其他组织同样从中受益。
我用的是 Windows、macOS 还是 Linux 有关系吗？没关系——GitHub 上列出了 Windows、macOS 和 Linux，而且最终生成的网站就是一个普通的网站，用浏览器打开就能看。
新建的网站自带哪些内容？包含上手所需的关键页面和板块：一个首页、一个文档区、一个博客，以及一些辅助页面。这些都可以自定义，让网站完全属于你自己的风格。
我能把文档发布成其他语言吗？可以——Docusaurus 内置了通过 CrowdIn 实现的多语言支持，你可以翻译自己的文档，围绕项目发展国际社区。
What are similar projects?nextra, nuvex-docs, docz, gatsby, fumadocs, mdBook, hexo, astro
Which topics is it in?documentation-generator, docs, mdx, website, blog, static-site-generator, localization, i18n, documentation, developers, hacktoberfest, markdown
Creator
facebook
Size
1.5 GB
Stars
66.5K
Updated
CommitOct 16Releasev3.10.2Jul 10
Age
9y
Commits · 90 Days