README.md

    Docusaurus

    Docusaurus

    Twitter Follow npm version Github Actions status PRs Welcome Discord Chat code style: prettier Tested with Jest Gitpod Ready-to-Code Netlify Status CI Score

    We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the Docusaurus v2 website for more details.

    Docusaurus v1 doc is available at v1.docusaurus.io and code is available on branch docusaurus-v1

    Introduction

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

    No time? Check our 5 minutes tutorial .

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

    • Simple to Start

    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.

    • Localizable

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

    • Customizable

    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 as well to ensure you have a site that is uniquely yours.

    Installation

    Use the initialization cli to create your site:

    npx @docusaurus/init@latest init [name] [template]

    Example:

    npx @docusaurus/init@latest init my-website classic

    Contributing

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

    Code of Conduct

    Facebook 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:

    • Discord with two text channels:
      • #docusaurus-users for those using Docusaurus.
      • #docusaurus-dev for those wanting to contribute to the Docusaurus core.
    • @docusaurus on Twitter
    • GitHub Issues

    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 or accessibility issues.

    项目简介

    🚀 Github 镜像仓库 🚀

    源项目地址

    https://github.com/facebook/docusaurus

    发行版本 103

    2.0.0-beta.7

    全部发行版

    贡献者 421

    全部贡献者

    开发语言

    • TypeScript 81.5 %
    • JavaScript 15.6 %
    • CSS 2.8 %
    • Shell 0.1 %
    • HTML 0.0 %