Skip to content

Commit f9d7b72

Browse files
committed
Document building a PDF
1 parent 558a792 commit f9d7b72

File tree

1 file changed

+40
-1
lines changed
  • modules/05-sharing-and-publishing

1 file changed

+40
-1
lines changed

modules/05-sharing-and-publishing/index.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -617,9 +617,48 @@ and <https://noyaml.com/>.
617617
:::
618618

619619

620+
#### Build the PDF
621+
622+
To build the PDF, try `myst build --pdf` again.
623+
624+
:::{important} 👀 You should notice...
625+
:class: simple
626+
:icon: false
627+
628+
```
629+
🖨 Rendering typst pdf to paper.pdf
630+
```
631+
:::
632+
633+
Try opening the PDF!
634+
Double-click `paper.pdf` in the JupyterLab file browser.
635+
636+
:::{important} 👀 You should notice...
637+
:class: simple
638+
:icon: false
639+
640+
The content is fairly simple.
641+
There is a title page, a blank table of contents, and then your content on the 3rd page.
642+
:::
643+
644+
This document was rendered with the `"plain_typst_book"` template.
645+
Other PDF template options are available!
646+
647+
Try running `myst templates list --typst` to see a list of available templates.
648+
649+
More information is available on the
650+
[official MyST PDF-building documentation](https://mystmd.org/guide/creating-pdf-documents)
651+
652+
620653
#### 🧠 What do we know now?
621654

622-
TODO
655+
* MyST documents can be built to multiple output formats, including PDFs.
656+
* Frontmatter is YAML metadata on a Markdown document that can tell MyST which documents
657+
should be built as PDF.
658+
* [Typst](https://typst.app/) can be used as an alternative document engine to
659+
$ \LaTeX $ for rendering PDFs by specifying `export.format: "typst"` in the frontmatter.
660+
* If you opened the collapsed section on quoting YAML, you know the author of this
661+
document has been burned too many times. **Quote your strings**! 😁
623662
624663
625664
## Hosting your website for free

0 commit comments

Comments
 (0)