Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boyney123/generator-create-docusaurus
A generator for new docusaurus projects.
https://github.com/boyney123/generator-create-docusaurus
documentation docusaurus generator yeoman
Last synced: 2 months ago
JSON representation
A generator for new docusaurus projects.
- Host: GitHub
- URL: https://github.com/boyney123/generator-create-docusaurus
- Owner: boyney123
- License: mit
- Created: 2019-05-31T10:11:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-11-01T13:51:13.000Z (about 5 years ago)
- Last Synced: 2024-10-28T18:52:41.590Z (2 months ago)
- Topics: documentation, docusaurus, generator, yeoman
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/generator-create-docusaurus
- Size: 9.49 MB
- Stars: 14
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - generator-create-docusaurus - A generator for new docusaurus projects. (JavaScript)
README
⚡ generator-create-docusaurus: quickly create documentation websites ⚡.
Use this generator to quickly get up and running with a documentation website for your project.
[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]
[![Version][version-badge]][version]
[](#contributors)
[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
[Donate ☕](https://www.paypal.me/boyney123/5)
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](https://docusaurus.io/) 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](https://docusaurus.io/) combined with [yeoman](https://yeoman.io/) to enable the rapid spin up of documentation websites.
This project was inspired and uses code from:
- [create-react-app](https://github.com/facebook/create-react-app)
- [Kent C. Dodds open source generator](https://github.com/kentcdodds/generator-kcd-oss)
- [Sindresorhus node generator](https://github.com/sindresorhus/generator-nm)
# Getting Started
_Make sure you have yeoman installed_
```sh
npm install -g yo
```
## Installing the generator
```sh
npm install -g generator-create-docusaurus
```
## Running the generator
Create your new documentation directory and run this command within it
```sh
yo create-docusaurus
```
Once everything is installed go to [http://localhost:3000](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.
[license-badge]: https://img.shields.io/github/license/boyney123/generator-create-docusaurus.svg?color=yellow
[license]: https://github.com/boyney123/generator-create-docusaurus/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[version-badge]: https://img.shields.io/npm/v/generator-create-docusaurus.svg?color=green
[version]: https://www.npmjs.com/package/generator-create-docusaurus
[github-watch-badge]: https://img.shields.io/github/watchers/boyney123/generator-create-docusaurus.svg?style=social
[github-watch]: https://github.com/boyney123/generator-create-docusaurus/watchers
[github-star-badge]: https://img.shields.io/github/stars/boyney123/generator-create-docusaurus.svg?style=social
[github-star]: https://github.com/boyney123/generator-create-docusaurus/stargazers
# Donating
If you find this tool useful, feel free to buy me a ☕ 👍
[Buy a drink](https://www.paypal.me/boyney123/5)
# License
MIT.
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
