Skip to content
New issue

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

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

Already on GitHub? # to your account

📖 Improve documentation around export config in the myst.yml #1807

Merged
merged 3 commits into from
Jan 28, 2025
Merged
Changes from 2 commits
Commits
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
28 changes: 28 additions & 0 deletions docs/documents-exports.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,34 @@ Below are supported export types and links to documentation for further reading:
You can also explore the [MyST templating](xref:jtex) documentation for a deeper dive into defining templates.
```

## Configuring Exports

There are two places to configure exports, you can do this directly in the markdown of your article that you are exporting:

```{code-block} yaml
:filename: article.md
---
title: My PDF
exports:
- format: pdf
template: arxiv_two_column
output: exports/my-document.pdf
---
```

Alternatively you can configure your export in your `myst.yml`, in this case you will need to specify the `article` (or `articles`) that you are targeting.

```{code-block} yaml
:filename: myst.yml
version: 1
project:
exports:
- format: pdf
template: arxiv_two_column
article: my-markdown-file.md
output: exports/my-document.pdf
```

## Building Exports

After defining `exports` in your frontmatter, you may build them with the `myst build` command, by default this only builds the site.
Expand Down
Loading