When building tools & APIS for developers it is important that we write some documentation on how to use it.
Docusaurus is a great tool to help building documentation websites, but you still have to edit various files to get it ready for production.
This project was created to bootstrap your documentation website.
This project uses Docusaurus combined with yeoman to enable the rapid spin up of documentation websites.
This project was inspired and uses code from:
Make sure you have yeoman installed
npm install -g yo
npm install -g generator-create-docusaurus
Create your new documentation directory and run this command within it
yo create-docusaurus
Once everything is installed go to http://localhost:3000 to see your new documentation website!
If you have any questions, features or issues please raise any issue or pull requests you like.
If you find this tool useful, feel free to buy me a ☕ 👍
MIT.
Thanks goes to these wonderful people (emoji key):
David Boyne 💻 📖 🎨 🤔 👀 🔧 |
This project follows the all-contributors specification. Contributions of any kind welcome!