https://github.com/thoughtbot/templates
Documentation templates for open source projects.
https://github.com/thoughtbot/templates
template
Last synced: 4 months ago
JSON representation
Documentation templates for open source projects.
- Host: GitHub
- URL: https://github.com/thoughtbot/templates
- Owner: thoughtbot
- License: mit
- Created: 2015-03-23T10:01:30.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2026-01-28T20:38:53.000Z (4 months ago)
- Last Synced: 2026-01-29T10:52:23.436Z (4 months ago)
- Topics: template
- Homepage:
- Size: 74.2 KB
- Stars: 74
- Watchers: 26
- Forks: 33
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md.template
- Contributing: CONTRIBUTING.md.template
- License: LICENSE.template
- Code of conduct: CODE_OF_CONDUCT.md.template
- Codeowners: CODEOWNERS.template
- Security: SECURITY.md
Awesome Lists containing this project
README
# Templates
Use the files in this repo as templates for your projects. Be sure to read
through them, understand their implications, and fill in the placeholders.
## Usage
```sh
cp templates/README.md.template my-awesome-project/README.md
$VISUAL my-awesome-project/README.md
```
### Dynamic content rendering for the footer
The [README.md.template](/README.md.template) includes a dynamic README
content snippet. That means the footer will be rendered and updated automatically
for you with the contents from the [footer](/templates/footer.md) template.
To make it work when using the [README.md.template](/README.md.template):
- copy the [github workflow example](/.github/workflows/dynamic-readme-example.yaml)
and rename it to `dynamic-readme`.
- add the repo path to the repository matrix in the [workflow dispatch](/.github/workflows/trigger-dynamic-readme-update.yaml).
## Contributing
See the [CONTRIBUTING] document.
Thank you, [contributors]!
[CONTRIBUTING]: CONTRIBUTING.md
[contributors]: https://github.com/thoughtbot/templates/graphs/contributors
## License
Open source templates are Copyright (c) thoughtbot, inc.
It contains free software that may be redistributed
under the terms specified in the [LICENSE] file.
[LICENSE]: /LICENSE
## About thoughtbot
This repo is maintained and funded by thoughtbot, inc.
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
We love open source software!
See [our other projects][community].
We are [available for hire][hire].
[community]: https://thoughtbot.com/community?utm_source=github
[hire]: https://thoughtbot.com/hire-us?utm_source=github