generator-create-docusaurus
v0.0.1
Published
A generator for new docusaurus projects. Based on create-react-app
Downloads
2
Maintainers
Readme
The problem
When building tools for developers we should really write documentation on how to use our tools.
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 enable fast development of documentation websites combining different technologies.
This solution
This project uses Docusaurusoc combined with yeoman to enable rapid spin up of documentation sites.
This project was inspired and uses code from:
Getting Started
Make sure you have yeoman installed
npm install -g yeoman
npm install -g generator-create-docusaurus
Next 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!
Contributing
If you have any questions, features or issues please raise any issue or pull requests you like.
Donating
If you find this tool useful, feel free to buy me a ☕ 👍
License
MIT.
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!