Skip to content

A template repository to get started with jtex templates for the MyST Markdown ecosystem.

Notifications You must be signed in to change notification settings

myst-templates/jtex-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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

About

A template repository to get started with jtex templates for the MyST Markdown ecosystem.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages