mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-12-26 06:14:52 +01:00
138 lines
3.7 KiB
Markdown
138 lines
3.7 KiB
Markdown
---
|
||
title: Extensions
|
||
---
|
||
|
||
# Extensions
|
||
|
||
Markdown is a very small language with a kind-of reference implementation called
|
||
[John Gruber's Markdown]. [Python Markdown] and [Python Markdown Extensions]
|
||
are two packages that enhance the Markdown writing experience, adding useful
|
||
syntax extensions for technical writing.
|
||
|
||
[John Gruber's Markdown]: https://daringfireball.net/projects/markdown/
|
||
[Python Markdown]: python-markdown.md
|
||
[Python Markdown Extensions]: python-markdown-extensions.md
|
||
|
||
## Supported extensions
|
||
|
||
The following extensions are all supported by Material for MkDocs and therefore
|
||
strongly recommended. Click on each extension to learn about its purpose and
|
||
configuration:
|
||
|
||
<div class="mdx-columns" markdown>
|
||
|
||
- [Abbreviations]
|
||
- [Admonition]
|
||
- [Arithmatex]
|
||
- [Attribute Lists]
|
||
- [BetterEm]
|
||
- [Caret, Mark & Tilde]
|
||
- [Critic]
|
||
- [Definition Lists]
|
||
- [Details]
|
||
- [Emoji]
|
||
- [Footnotes]
|
||
- [Highlight]
|
||
- [Keys]
|
||
- [Markdown in HTML]
|
||
- [SmartSymbols]
|
||
- [Snippets]
|
||
- [SuperFences]
|
||
- [Tabbed]
|
||
- [Table of Contents]
|
||
- [Tables]
|
||
- [Tasklist]
|
||
|
||
</div>
|
||
|
||
[Abbreviations]: python-markdown.md#abbreviations
|
||
[Admonition]: python-markdown.md#admonition
|
||
[Arithmatex]: python-markdown-extensions.md#arithmatex
|
||
[Attribute Lists]: python-markdown.md#attribute-lists
|
||
[BetterEm]: python-markdown-extensions.md#betterem
|
||
[Caret, Mark & Tilde]: python-markdown-extensions.md#caret-mark-tilde
|
||
[Critic]: python-markdown-extensions.md#critic
|
||
[Definition Lists]: python-markdown.md#definition-lists
|
||
[Details]: python-markdown-extensions.md#details
|
||
[Emoji]: python-markdown-extensions.md#emoji
|
||
[Footnotes]: python-markdown.md#footnotes
|
||
[Highlight]: python-markdown-extensions.md#highlight
|
||
[Keys]: python-markdown-extensions.md#keys
|
||
[Markdown in HTML]: python-markdown.md#markdown-in-html
|
||
[SmartSymbols]: python-markdown-extensions.md#smartsymbols
|
||
[Snippets]: python-markdown-extensions.md#snippets
|
||
[SuperFences]: python-markdown-extensions.md#superfences
|
||
[Tabbed]: python-markdown-extensions.md#tabbed
|
||
[Table of Contents]: python-markdown.md#table-of-contents
|
||
[Tables]: python-markdown.md#tables
|
||
[Tasklist]: python-markdown-extensions.md#tasklist
|
||
|
||
## Configuration
|
||
|
||
Extensions are configured as part of `mkdocs.yml` – the MkDocs configuration
|
||
file. The following sections contain two example configurations to bootstrap
|
||
your documentation project.
|
||
|
||
[overview]: #advanced-configuration
|
||
|
||
### Minimal configuration
|
||
|
||
This configuration is a good starting point for when you're using Material for
|
||
MkDocs for the first time. The best idea is to explore the [reference], and
|
||
gradually add what you want to use:
|
||
|
||
``` yaml
|
||
markdown_extensions:
|
||
|
||
# Python Markdown
|
||
- toc:
|
||
permalink: true
|
||
|
||
# Python Markdown Extensions
|
||
- pymdownx.highlight
|
||
- pymdownx.superfences
|
||
```
|
||
|
||
[reference]: ../../reference/index.md
|
||
|
||
### Recommended configuration
|
||
|
||
This configuration enables all Markdown-related features of Material for MkDocs
|
||
and is great for experienced users bootstrapping a new documentation project:
|
||
|
||
``` yaml
|
||
markdown_extensions:
|
||
|
||
# Python Markdown
|
||
- abbr
|
||
- admonition
|
||
- attr_list
|
||
- def_list
|
||
- footnotes
|
||
- md_in_html
|
||
- toc:
|
||
permalink: true
|
||
|
||
# Python Markdown Extensions
|
||
- pymdownx.arithmatex:
|
||
generic: true
|
||
- pymdownx.betterem:
|
||
smart_enable: all
|
||
- pymdownx.caret
|
||
- pymdownx.details
|
||
- pymdownx.emoji:
|
||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||
- pymdownx.highlight
|
||
- pymdownx.inlinehilite
|
||
- pymdownx.keys
|
||
- pymdownx.mark
|
||
- pymdownx.smartsymbols
|
||
- pymdownx.superfences
|
||
- pymdownx.tabbed:
|
||
alternate_style: true
|
||
- pymdownx.tasklist:
|
||
custom_checkbox: true
|
||
- pymdownx.tilde
|
||
```
|