MyST has strong support for referencing and reusing content. MyST nodes can be referenced or embedded, even from external projects! These features help to more seamlessly share content between MyST projects, so your project can become part of a larger network of resources.
Referencing¶
Internally¶
Review the references section of the cheat sheet for a reminder of the syntax.
External MyST projects¶
The MyST guide has already been added as an external reference for this project.
It has been given the label myst-guide, so it can be referenced with [](xref:myst-guide).
16 17references: myst-guide: https://mystmd.org/guide
Embedding¶
The embed directive allows you to reuse content in-place.
This is helpful if you want to have the same content in two places, without repeating the source or interrupting the flow of a page with a link.
Internally¶
External MyST projects¶
Just like with cross-references, you can also embed content from external MyST projects.
Referencing other internet resources¶
Like with MyST references, some links to non-MyST resources are handled specially and have dynamic, interactive tooltips.
Wikipedia¶
Use [](wiki:) to create a reference to your favourite Wikipedia article.
DOIs¶
Use [](doi:) to create a reference to a document.
You can find many documents with DOIs on Zenodo
GitHub¶
Links to GitHub have dynamic tooltips which can show issues, pull requests, and lines of code.
Use [](https://github.com) to create a references to GitHub objects.
If you are not sure which GitHub repository to use, try mystmd.