https://github.com/elyseholladay/generator-standard-docs-templates
A generator that creates standard templates for common repository documentation.
https://github.com/elyseholladay/generator-standard-docs-templates
contributing-template documentation documentation-generator documentation-tool readme-boilerplate readme-template
Last synced: about 1 year ago
JSON representation
A generator that creates standard templates for common repository documentation.
- Host: GitHub
- URL: https://github.com/elyseholladay/generator-standard-docs-templates
- Owner: elyseholladay
- License: mit
- Created: 2019-03-01T20:55:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T22:57:09.000Z (over 3 years ago)
- Last Synced: 2025-02-10T13:24:37.193Z (over 1 year ago)
- Topics: contributing-template, documentation, documentation-generator, documentation-tool, readme-boilerplate, readme-template
- Language: JavaScript
- Size: 649 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# generator-standard-docs-templates
> A generator that creates standard templates for common repository documentation.
To make it easy for engineers on your team to do the right thing and write great documentation, this package generates standard documentation templates. Using a Yeoman generator CLI, you can answer questions to get a pre-filled README.
* **README** — As the entry point to the tool, a good README should explain what the tool is, how to use and install it, and how to get in touch with maintainers. A standard README template makes it easy for consumers to find the information they need.
## Table of Contents
* [Install](#install)
* [Usage](#usage)
* [Releases](#releases)
* [Maintainers](#maintainers)
* [Contributing](#contributing)
* [License](#license)
## Usage
This currently only works locally, as this package is not published to npm. In this project, run `npm link .`
Then, in the project where you want to generate a README, run the generator with npx:
```bash
npx yo generator-standard-docs-templates
```
## Releases
This project follows [Semantic Versioning](https://semver.org/). Release versions can be found on the [Releases page](https://github.com/elyseholladay/generator-standard-docs-templates/releases).
## Maintainers
* [Elyse Holladay](https://github.com/elyseholladay)
## Contributing
Contributions and PRs are accepted on this project.
Please read the [CONTRIBUTING.md](CONTRIBUTING.md) for information on how to contribute.
`this-project` is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
## License
`this-project` is licensed under the [MIT License](LICENSE).