Typademic turns distraction freely written markdown files into beautiful PDFs.
This GitHub template is agnostic to the programming language used, uses GitHub Actions to manage issues and pull requests, and helps enforce best practices for small projects. To use the template, generate a new project and perform the following tasks.
- add
Moritz Mähr,maehr,typademicandSHORT_DESCRIPTIONto README.md and change it according to www.makeareadme.com - add
typademicto package.json according to npm docs - change
moritz.maehr@gmail.comin CODE_OF_CONDUCT.md - use www.gitignore.io to enhance .gitignore
- use gitattributes.io to enhance .gitattributes
- add example environment variables to example.env
- add GitHub actions in
.github/workflows/according to starter-workflows - activate gh-pages
- protect the main branch to enforce a fork and pull workflow
- activate GitHub security alerts and change SECURITY.md accordingly
- add favicons to
./, for example via favicon.io - keep a
CHANGELOG.mdaccording to keepachangelog.com
Use the package manager npm to install Prettier.
npm installnpm run check
npm run formatThis project is maintained by @maehr. Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly, so that more people can benefit from it.
| Type | Platforms |
|---|---|
| 🚨 Bug Reports | GitHub Issue Tracker |
| 🎁 Feature Requests | GitHub Issue Tracker |
| 🛡 Report a security vulnerability | GitHub Issue Tracker |
No changes are currently planned.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Moritz Mähr - Initial work - maehr
See also the list of contributors who participated in this project.
This project is licensed under the GNU General Public License v3.0 - see the LICENSE.md file for details