Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ulisesgascon/generator-fast-documentation
A yeoman-based template to generate a great documentation website
https://github.com/ulisesgascon/generator-fast-documentation
Last synced: 2 days ago
JSON representation
A yeoman-based template to generate a great documentation website
- Host: GitHub
- URL: https://github.com/ulisesgascon/generator-fast-documentation
- Owner: UlisesGascon
- License: mit
- Created: 2022-11-17T07:28:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-03T22:21:51.000Z (over 1 year ago)
- Last Synced: 2024-10-02T20:08:13.372Z (3 days ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/generator-fast-documentation
- Size: 1.71 MB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
generator-fast-documentation
A yeoman-based template to generate a great documentation website
# About
A yeoman-based template to generate a great documentation website.
❤️ Awesome Features:
- Ship fast! Docker support. 🔥
- Opinionated Docusaurus config out-of-the-box 🍺
- Easy control releases with standard-release out-of-the-box 🎉
- Simple CI with github Actions out-of-the-box 📦
- Just few simple questions to generate the perfect documentation 💪
- Easy to use and great test coverage ✅
- Add your content with [Markdown](https://docusaurus.io/docs/markdown-features) and [MDX](https://docusaurus.io/docs/markdown-features/react) 🚂
## Tutorial
[](https://youtu.be/Gpdw-oDIgBQ)
## Usage
You need to install [Yeoman](https://www.npmjs.com/package/yo)
```bash
npm i -g generator-fast-documentation
yo fast-documentation
```
## Built With
Development only:
- [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli) - Lint commit messages
- [@commitlint/config-conventional](https://www.npmjs.com/package/@commitlint/config-conventional) - npm i @commitlint/config-conventional
- [jest](https://www.npmjs.com/package/jest) - Delightful JavaScript Testing
- [standard](https://www.npmjs.com/package/standard) - JavaScript style guide, linter, and formatter
- [standard-version](https://www.npmjs.com/package/standard-version) - A utility for versioning using semver and CHANGELOG generation powered by Conventional Commits.
- [yeoman-assert](https://www.npmjs.com/package/yeoman-assert) - yeoman-assert is extending the native Node.js assert module.
- [yeoman-test](https://www.npmjs.com/package/yeoman-test) - Test utilities for Yeoman generators
- [husky](https://www.npmjs.com/package/husky) - Modern native Git hooks made easy
Production only:
- [chalk](https://www.npmjs.com/package/chalk) - Terminal string styling done right
- [yeoman-generator](https://www.npmjs.com/package/yeoman-generator) - Rails-inspired generator system that provides scaffolding for your apps
- [yosay](https://www.npmjs.com/package/yosay) - Tell Yeoman what to say
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/ulisesGascon/generator-fast-documentation/tags).
## Authors
- **Ulises Gascón** - *Initial work- - [@ulisesGascon](https://github.com/ulisesGascon)
See also the list of [contributors](https://github.com/ulisesGascon/generator-fast-documentation/contributors) who participated in this project.
## License
This project is licensed under the GNU AGPL3.0 License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
- This project is under development, but you can help us to improve it! We :heart: FOSS!