    Skip to content

      Navigation Menu

            Sign in Appearance settings
                * Platform
                        + AI CODE CREATION
                            o GitHub Copilot Write better code with AI
                            o GitHub Copilot app Direct agents from issue to merge
                            o MCP Registry Integrate external tools
                        + DEVELOPER WORKFLOWS
                            o Actions Automate any workflow
                            o Codespaces Instant dev environments
                            o Issues Plan and track work
                            o Code Review Manage code changes
                            o Code Quality Enforce quality at merge
                        + APPLICATION SECURITY
                            o GitHub Advanced Security Find and fix vulnerabilities
                            o Code security Secure your code as you build
                            o Secret protection Stop leaks before they start
                        + EXPLORE
                            o Why GitHub
                            o Documentation
                            o Blog
                            o Changelog
                            o Marketplace
                      View all features
                * Solutions
                        + BY COMPANY SIZE
                            o Enterprises
                            o Small and medium teams
                            o Startups
                            o Nonprofits
                        + BY USE CASE
                            o App Modernization
                            o DevSecOps
                            o DevOps
                            o CI/CD
                            o View all use cases
                        + BY INDUSTRY
                            o Healthcare
                            o Financial services
                            o Manufacturing
                            o Government
                            o View all industries
                      View all solutions
                * Resources
                        + EXPLORE BY TOPIC
                            o AI
                            o Software Development
                            o DevOps
                            o Security
                            o View all topics
                        + EXPLORE BY TYPE
                            o Customer stories
                            o Events & webinars
                            o Ebooks & reports
                            o Business insights
                            o GitHub Skills
                        + SUPPORT & SERVICES
                            o Documentation
                            o Customer support
                            o Community forum
                            o Trust center
                            o Partners
                      View all resources
                * Open Source
                        + COMMUNITY
                            o GitHub Sponsors Fund open source developers
                        + PROGRAMS
                            o Security Lab
                            o Maintainer Community
                            o Accelerator
                            o GitHub Stars
                            o Archive Program
                        + REPOSITORIES
                            o Topics
                            o Trending
                            o Collections
                * Enterprise
                        + ENTERPRISE SOLUTIONS
                            o Enterprise platform AI-powered developer platform
                        + AVAILABLE ADD-ONS
                            o GitHub Advanced Security Enterprise-grade security features
                            o Copilot for Business Enterprise-grade AI features
                            o Premium Support Enterprise-grade 24/7 support
              * Pricing
                Type / to search
                Sign in
              Sign up Appearance settings
      You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert

              Uh oh!

              There was an error while loading. Please reload this page.

              facebook / docusaurus Public

                      * Uh oh!

                        There was an error while loading. Please reload this page.

              * Notifications You must be signed in to change notification settings
              * Fork 10k
                * Star 65.9k
          * Code
          * Issues 294
          * Pull requests 129
          * Discussions
          * Actions
          * Projects
          * Security and quality 0
          * Insights
          Additional navigation options
                  * Code
                  * Issues
                  * Pull requests
                  * Discussions
                  * Actions
                  * Projects
                  * Security and quality
                  * Insights
                                              main
                                          Branches Tags
                                            Go to file
                                        Code
                                          Open more actions menu

                                        Folders and files

                                          Name                               Name                                 Last commit message    Last commit date
                                            Latest commit                  
                                                                           
                                                History                    
                                                                           
                                                6,741 Commits              
                                                  6,741 Commits            
                                                  .devcontainer                      .devcontainer                                                       
                                                  .github                            .github                                                             
                                                  .husky                             .husky                                                              
                                                  .vscode                            .vscode                                                             
                                                  __tests__                          __tests__                                                           
                                                  admin                              admin                                                               
                                                  argos                              argos                                                               
                                                  examples                           examples                                                            
                                                  packages                           packages                                                            
                                                  test                               test                                                                
                                                  website                            website                                                             
                                                  .cspell.json                       .cspell.json                                                        
                                                  .editorconfig                      .editorconfig                                                       
                                                  .gitattributes                     .gitattributes                                                      
                                                  .gitignore                         .gitignore                                                          
                                                  .gitpod.yml                        .gitpod.yml                                                         
                                                  .lintstagedrc.json                 .lintstagedrc.json                                                  
                                                  .nvmrc                             .nvmrc                                                              
                                                  .oxfmtrc.json                      .oxfmtrc.json                                                       
                                                  .stylelintignore                   .stylelintignore                                                    
                                                  .stylelintrc.js                    .stylelintrc.js                                                     
                                                  .syncpackrc.ts                     .syncpackrc.ts                                                      
                                                  .watchmanconfig                    .watchmanconfig                                                     
                                                  AGENTS.md                          AGENTS.md                                                           
                                                  CHANGELOG-v2.md                    CHANGELOG-v2.md                                                     
                                                  CHANGELOG.md                       CHANGELOG.md                                                        
                                                  CODE_OF_CONDUCT.md                 CODE_OF_CONDUCT.md                                                  
                                                  CONTRIBUTING.md                    CONTRIBUTING.md                                                     
                                                  LICENSE                            LICENSE                                                             
                                                  LICENSE-docs                       LICENSE-docs                                                        
                                                  README.md                          README.md                                                           
                                                  crowdin-v2.yaml                    crowdin-v2.yaml                                                     
                                                  eslint.config.ts                   eslint.config.ts                                                    
                                                  eslint.rules.ts                    eslint.rules.ts                                                     
                                                  lerna.json                         lerna.json                                                          
                                                  package.json                       package.json                                                        
                                                  pnpm-lock.yaml                     pnpm-lock.yaml                                                      
                                                  pnpm-workspace.yaml                pnpm-workspace.yaml                                                 
                                                  project-words.txt                  project-words.txt                                                   
                                                  tsconfig.base.client.json          tsconfig.base.client.json                                           
                                                  tsconfig.base.json                 tsconfig.base.json                                                  
                                                  vitest.config.ts                   vitest.config.ts                                                    
                                            View all files                 
                                          

                                              Repository files navigation

                                                * 
                                                * README
                                                * Code of conduct
                                                * Contributing
                                                * MIT license
                                                * CC-BY-4.0 license
                                                * Security
                                                More items

                                                  Docusaurus


                                                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.

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

                                                * Discord:
                                                    + #general for those using Docusaurus.
                                                    + #contributors for those wanting to contribute to the Docusaurus core.
                                                * @docusaurus X
                                                * 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 supports us with free access for open source.

                                              Rocket Validator helps us find HTML markup and accessibility issues.

                                        About

                                        Easy to maintain open source documentation websites.

                                          docusaurus.io

                                        Topics

                                          documentationhacktoberfestjavascriptopen-sourcereactwebsite

                                        Resources

                                          Readme
                                          MIT, CC-BY-4.0 licenses found

                                        Code of conduct

                                          Code of conduct

                                        Contributing

                                          Contributing

                                        Security policy

                                          Security policy
                                          Activity
                                          Custom properties

                                        Stars

                                          65.9k stars

                                        Watchers

                                          434 watching

                                        Forks

                                          10.0k forks
                                          Report repository

                                        Releases

                                        Sponsor this project

                                        Packages

                                        Used by

                                        Contributors

                                        Languages

    Footer

        © 2026 GitHub, Inc.

      Footer navigation

        * Terms
        * Privacy
        * Security
        * Status
        * Community
        * Docs
        * Contact
        * Manage cookies
        * Do not share my personal information
      You can’t perform that action at this time.