Skip to content

Commit

Permalink
📖 Improve documentation around export config in the myst.yml (#1807)
Browse files Browse the repository at this point in the history
Co-authored-by: Franklin Koch <[email protected]>
  • Loading branch information
rowanc1 and fwkoch authored Jan 28, 2025
1 parent eacacd9 commit e2c63d2
Showing 1 changed file with 28 additions and 0 deletions.
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: my-markdown-file.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

0 comments on commit e2c63d2

Please sign in to comment.