https://github.com/myst-templates/templates
List of all MyST Markdown community templates.
https://github.com/myst-templates/templates
Last synced: 28 days ago
JSON representation
List of all MyST Markdown community templates.
- Host: GitHub
- URL: https://github.com/myst-templates/templates
- Owner: myst-templates
- Created: 2022-09-28T16:54:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-01T20:52:49.000Z (about 2 months ago)
- Last Synced: 2025-03-01T21:26:47.709Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://api.mystmd.org/templates
- Size: 667 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-myst - MyST Templates GitHub Organization
README
# MyST Templates
A community curated collection of [MyST Markdown](https://mystmd.org) compatible templates.
These templates allow `myst` to export markdown files as typeset, formatted documents using PDF, LaTeX, Typst, or Word.
Templates can expose data-driven options for customization ensuring the final documents comply with author submission guidelines provided by a particular journal, conference organizer or university.
This repository:
- holds issues for new and general information for improving existing templates
- downloads each template listed in the [data](./data) folder
- deploys an API to https://api.mystmd.org
- automatically updates the organization readme
## Contributing a LaTeX Template
To add a new LaTeX template, [fork this repo](https://github.com/myst-templates/templates/fork), and modify [tex.yml](./data/tex.yml), the new template should be added as a new entry in the listing:
```yaml
templates:
- organization: myst
name: agu2019
source: https://github.com/myst-templates/agu2019
latest: main
```
Once you've made your change, open a PR.
## Contributing a Docx Template
Docx templating currently requires a dynamic rendering function using [docx](https://docx.js.org/#/) passed directly to `mystmd`.
However, data-driven options specified by a `template.yml` are still passed to this renderer. These may be added at [docx.yml](./data/docx.yml), similar to LaTeX template.
[Fork this repo](https://github.com/myst-templates/templates/fork), make your change and open a PR.
## Development
Install the mini CLI tool using `npm install` and `npm run dev` (puts this in watch mode, so you can kill after the output is complete).
Then call `myst-templates-api index data/tex.yml` from the main folder, which will create an index file and update the organization Readme.