From e2c63d28c5bf8f7692a96eab18571336874a1234 Mon Sep 17 00:00:00 2001 From: Rowan Cockett Date: Tue, 28 Jan 2025 08:52:15 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20Improve=20documentation=20around?= =?UTF-8?q?=20export=20config=20in=20the=20myst.yml=20(#1807)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Franklin Koch --- docs/documents-exports.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/documents-exports.md b/docs/documents-exports.md index f53eaba21..47593a992 100644 --- a/docs/documents-exports.md +++ b/docs/documents-exports.md @@ -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.