Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 2.1 KB

README.md

File metadata and controls

26 lines (21 loc) · 2.1 KB

MyST Template (jtex) - Cookiecutter

Create a LaTeX template that works with MyST Markdown, 👉 full tutorial is here 👈. This cookiecutter repository helps you get setup with creating a jtex template for working with MyST Markdown.

pip install cookiecutter
cookiecutter gh:myst-templates/jtex-template

You can also choose to fork this repository, and replace the templated values in all files!

Steps to creating your own template!

  • 🆕 cookiecutter gh:myst-templates/jtex-template (or fork this repository, and update the template values)
  • 📑 Replace the template.tex with your existing LaTeX template/article
  • 👯‍♀️ Copy in any other style, definitions or images necessary for the template
  • 👩‍🔬 Add the files necessary into files list in the template.yml (documentation)
  • 🧙‍♀️ Start replacing template values with [-options.my_value-] and put in [# if parts.abstract #] conditions to toggle sections on and off (documentation)
  • 👩🏿‍💻 Install jtex (npm install -g jtex) and run jtex check (documentation)
  • 🪄 Continue to improve the options in your template for parts and options (documentation)
  • 💾 When ready, save your template.yml and run jtex check --fix, this will add various packages that are auto detected and fix document options (documentation)
  • 🧪 Test with real content: myst build my-document.md --template ../path/to/template (documentation)
  • 📸 Create a thumbnail.png with an accurate screenshot of the template
  • 🧭 Update this README, and check all values in the template.yml
  • 🚀 Push to GitHub, and contribute to the community templates repository