Have ideas to improve npm?Join in the discussion! »

    docusaurus

    1.14.7 • Public • Published

    Docusaurus

    Docusaurus

    npm version CircleCI Status PRs Welcome Chat code style: prettier Tested with Jest Netlify Status

    Introduction

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

    • Simple to Start Docusaurus is built to be easy to get up and running in as little time 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

    Docusaurus is available as the docusaurus package on npm.

    We have also released the docusaurus-init package to make getting started with Docusaurus even easier.

    Contributing

    We've released Docusaurus because it helps us better scale and support 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.

    Install

    npm i docusaurus

    DownloadsWeekly Downloads

    12,005

    Version

    1.14.7

    License

    MIT

    Unpacked Size

    592 kB

    Total Files

    173

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar