Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.08 KB

05-markdown-files.md

File metadata and controls

29 lines (22 loc) · 1.08 KB
title short_title subtitle license subject venue open_access date
Previewing Markdown Files
Finite Volume
Methods for Finite Volume Simulations
CC-BY-4.0
Tutorial
title
MyST Markdown
true
2023/07/05

With the JupyterLab MyST extension, you can also open and preview a markdown file as you are working on it. This will open up in real time and show you the updates! 🎉

:::{important} To see the frontmatter, you must enable the settings as JupyterLab automatically removes the frontmatter before passing it to the renderer! (#14772).

🛠 Settings > Search for Frontmatter > Enable Frontmatter.

Changing the markdown document should now work! :::

The markdown document can use any of the same roles and directives from MyST with hover-previews. Any document, including notebooks, can be exported to a PDF document.

:::{card} 📜 Working with MyST Documents :link: https://mystmd.org/guide/quickstart-myst-documents

Use this tutorial to learn how to export to Microsoft Word 📄 and various scientific PDF templates. :::