Awesome Open Source
Awesome Open Source

Academic Pandoc template

Write beautiful academic texts with the distraction-free Pandoc Markdown and typademic.

GitHub issues GitHub forks GitHub stars GitHub license

Preview

Getting Started

Read the documentation and make sure you have a Markdown editor like Zettlr and a Bibtex editor like JabRef installed.

Use with GitHub actions

  1. Fork the academic-pandoc-template
  2. Edit /template/academic-pandoc-template.md according to the Markdown guide online, with Zettlr or with your favorite Markdown editor
  3. Edit /template/references.bib online, with JabRef or with your favorite Bibtex editor
  4. Commit your changes
  5. GitHub actions will compile an updated PDF and a DOCX document and store these artifacts

Use with typademic online

  1. Clone or download the academic-pandoc-template
  2. Edit /template/academic-pandoc-template.md according to the Markdown guide with Zettlr or your favorite Markdown editor
  3. Edit /template/references.bib with JabRef or your favorite Bibtex editor
  4. Upload all files in /template/ to typademic and convert it to PDF or Docx

Use with Pandoc and Latex

Install all prerequisites

Open your command line and execute the following commands.

pandoc -d pdf.yaml
pandoc -d docx.yaml

Support

This 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

Built With

Roadmap

No changes are currently planned.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Moritz Mähr - Initial work - maehr

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
tex (1,157
markdown (887
pdf (448
latex (304
pandoc (68
latex-template (55
docx (51
markdown-converter (17