@hsluoyz/docusaurus
v1.5.2
Published
Easy to Maintain Open Source Documentation Websites
Downloads
2
Maintainers
Readme
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.
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.