Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 Contribute template docs #970

Merged
merged 2 commits into from
Mar 11, 2024
Merged

📖 Contribute template docs #970

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
222f42a
📖 Contribute template docs
rowanc1 Mar 11, 2024
3779e0b
Remove jtex
rowanc1 Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,5 @@ parts:
- file: glossary
- caption: Contribute
chapters:
- file: contribute-templates
- file: contribute-docs
28 changes: 28 additions & 0 deletions docs/contribute-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Contribute a LaTeX, Word or Typst Template
short_title: Create a Template
description: Create a MyST Template so others in the MyST community can make use of your work and potentially improve it. There is an API to list all templates, and when you contribute it, your template will show up in command line queries, like listing all `myst templates`.
---

The [MyST templates organization](https://github.com/myst-templates) curates a community collection of MyST Markdown compatible templates. These templates allow MyST to export markdown files as typeset, formatted documents using PDF, LaTeX, Word or Typst templates. These templates expose data-driven options for customization ensuring the final documents comply with author submission guidelines provided by a particular journal, conference organizer or university.

## Creating a Template

To create a template, you can [follow the guide](https://mystmd.org/jtex/create-a-latex-template), as well as see the video below. Note that these guides are currently written for LaTeX, but can be generalized for Word and Typst. Documentation updates welcome!

````{note} See the video tutorial 📺
:class: dropdown
```{iframe} https://www.youtube.com/embed/-oD6jlM23wY
:width: 100%
```
````

## Contributing a Template

MyST welcomes contributions of new templates, or improvements to any of our curated templates. To get started with LaTeX:

- 📝 [open an issue](https://github.com/myst-templates/templates/issues) - tell us about the template you'd like added. Provide a link to the template if it's online, or attach the files if you have them.
- 🏋🏽‍♀️ [create your own template](https://mystmd.org/jtex/create-a-latex-template) - Learn how to create your own template in a few easy steps!
- 🤝 [contribute a template](https://mystmd.org/jtex/contribute-a-template) - Even if it's partial or barely started we'll help test and get it over the line.

For more details on contributing, learning about the structure of templates specifically and how to build one. See the [Contributors Guide](https://mystmd.org/jtex/contribute-a-template) in `jtex`.
Loading