Write beautiful academic texts with the distraction-free Pandoc Markdown and typademic.
Read the documentation and make sure you have a Markdown editor like Zettlr and a Bibtex editor like JabRef installed.
Use with GitHub actions
- Fork the academic-pandoc-template
- Edit
/template/academic-pandoc-template.mdaccording to the Markdown guide online, with Zettlr or with your favorite Markdown editor - Edit
/template/references.bibonline, with JabRef or with your favorite Bibtex editor - Commit your changes
- GitHub actions will compile an updated PDF and a DOCX document and store these artifacts
Use with typademic online
- Clone or download the academic-pandoc-template
- Edit
/template/academic-pandoc-template.mdaccording to the Markdown guide with Zettlr or your favorite Markdown editor - Edit
/template/references.bibwith JabRef or your favorite Bibtex editor - Upload all files in
/template/to typademic and convert it to PDF or Docx
Install all prerequisites
Open your command line and execute the following commands.
pandoc -d pdf.yaml
pandoc -d docx.yamlThis 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 MIT License - see the LICENSE.md file for details