boyney123 / generator-create-docusaurus

A generator for new docusaurus projects.

⚡ generator-create-docusaurus: quickly create documentation websites ⚡.

Use this generator to quickly get up and running with a documentation website for your project.

---

Donate ☕

---

Features: Setup within minutes, feature examples, docs example and more...

---

The problem

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 solution

This project uses Docusaurus combined with yeoman to enable the rapid spin up of documentation websites.

This project was inspired and uses code from:

• create-react-app
• Kent C. Dodds open source generator
• Sindresorhus node generator

Getting Started

Make sure you have yeoman installed

npm install -g yo

Installing the generator

npm install -g generator-create-docusaurus

Running the generator

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 ☕ 👍

Buy a drink

License

MIT.

Contributors

Thanks goes to these wonderful people (emoji key):

David Boyne 💻 📖 🎨 🤔 👀 🔧

This project follows the all-contributors specification. Contributions of any kind welcome!