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
• Usage
• Releases
• Maintainers
• Contributing
• 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:

npx yo generator-standard-docs-templates

Releases

This project follows Semantic Versioning. Release versions can be found on the Releases page.

Maintainers

• Elyse Holladay

Contributing

Contributions and PRs are accepted on this project.

Please read the CONTRIBUTING.md for information on how to contribute.

this-project is governed by the Contributor Covenant Code of Conduct.

License

this-project is licensed under the MIT License.