Snippets Pymdown Extension

The Snippets extension adds the ability to embed content from arbitrary text files in your markdown document.

Setup

Enable Snippets by adding pymdownx.snippets to the markdown_extensions configuration in mkdocs.yml:

markdown_extensions:
  - pymdownx.snippets:
      base_path: 
        - docs

See the Snippets documentation for more information on configuration options.

Usage

Let's say you have a header that you want to add to several documentation pages:

file: links.md
file location: ./configuration/palettes/links.md

<nav class="terminal-mkdocs-pad-to-match-side-nav" markdown>
[Default](default.md) |
[Gruvbox Dark](gruvbox-dark.md) |
[Dark](dark.md) |
[Pink](pink.md) |
[Sans](sans.md) |
[Sans Dark](sans-dark.md)
</nav>

You can add the --8<-- snippet marker to the page where you want to include this header:

file: gruvbox-dark.md
file location: ./configuration/palettes/gruvbox-dark.md

--8<--
configuration/palettes/links.md
--8<--

# Gruvbox Dark Palette

To use the gruvbox_dark color palette, add the `palette` attribute to your theme configuration in `mkdocs.yml`:
...

This will result in a final markdown for gruvbox-dark.md which includes the content in links.md:

<nav class="terminal-mkdocs-pad-to-match-side-nav" markdown>
[Default](default.md) |
[Gruvbox Dark](gruvbox-dark.md) |
[Dark](dark.md) |
[Pink](pink.md) |
[Sans](sans.md) |
[Sans Dark](sans-dark.md)
</nav>

# Gruvbox Dark Palette

To use the gruvbox_dark color palette, add the `palette` attribute to your theme configuration in `mkdocs.yml`:
...