Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rowanc1 committed Apr 24, 2024
1 parent 249b104 commit 81d7490
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/embed.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ For example, the following references the admonitions list in [](admonitions.md)
```


### The `![](#embed)` short-hand

The embedding markdown shorthand lets you quickly embed content using the Markdown image syntax (see more about [images](./figures.md)).
Expand Down Expand Up @@ -154,6 +153,13 @@ If you are working with the auto-reload (e.g. `myst start`), the file dependenci
Circular dependencies are not allowed and MyST will issue a warning and not render the recursion.
:::

:::{tip} Math and abbreviation frontmatter from included files
:class: dropdown
When including a file that has frontmatter, only some of that frontmatter is used. For example, the `math` macros and `abbreviations` are brought up to the top level and will overwrite any macros or abbreviations that already exist.

For LaTeX, the commands like `\newcommand` and `\renewcommand` are shared in the same way that math macros are shared for markdown files.
:::

## `{embed}` vs. `{include}`

The {myst:directive}`include` directive is very similar to {myst:directive}`embed`, with a few key differences.
Expand Down

0 comments on commit 81d7490

Please sign in to comment.