Skip to content

PyMdown extensions

PyMdown extensions

pymdownx.caret

Hello, I'm text with an insert.

Hello, I'm text witha superscript

Hello, I'm text with ^^an insert^^.

Hello, I'm text with^a\ superscript^
msgid "Hello, I'm text with ^^an insert^^."
msgstr "Hola, soy texto con ^^una inserción^^."

msgid "Hello, I'm text with^a\\ superscript^."
msgstr "Hola, soy texto con^un\\ superíndice^"

pymdownx.details

Open styled details
Nested details!

And more content.

???+ note "Open styled details"

    ??? danger "Nested details!"

        And more content.
msgid "Open styled details"
msgstr "Detalles con estilo abierto"

msgid "Nested details!"
msgstr "¡Detalles anidados!"

msgid "And more content."
msgstr "Y más contenido."

pymdownx.emoji

I ❤ mdpo

I :heart: mdpo
msgid "I :heart: mdpo"
msgstr "Me encanta mdpo :+1:"

pymdownx.highlight

Code blocks are not translated by default, but you can include a <!-- mdpo-include-codeblock --> HTML comment before each code block that you want translate.

import mdpo
print(mdpo.__version__)
\<!-- mdpo-include-codeblock -->
```python
import mdpo
print(mdpo.__version__)
```
msgid ""
"import mdpo\\n"
"print(mdpo.__version__)\\n"
msgstr ""

pymdownx.inlinehilite

There is no way of skip inline codespan blocks from being included in translations:

Here is some code: import pymdownx; pymdownx.__version__.

The mock shebang will be treated like text here: #!js var test = 0;.

Here is some code: `#!py3 import pymdownx; pymdownx.__version__`.

The mock shebang will be treated like text here: ` #!js var test = 0;`.
msgid "Here is some code: `#!py3 import pymdownx; pymdownx.__version__`."
msgstr ""
"Aquí hay algo de código: `#!py3 import pymdownx; pymdownx.__version__`."

msgid ""
"The mock shebang will be treated like text here: ` #!js var test = 0;`."
msgstr ""
"El shebang simulado se tratará como texto aquí: ` #!js var test = 0;`."

pymdownx.keys

Ctrl+Alt+Del

++ctrl+alt+delete++
msgid "++ctrl+alt+delete++"
msgstr "++ctrl+alt+f10++"

Sometimes the translation should edit links. See the next example linking to this documentation depending on the current active language:

You can access to the mkdocs-mdpo-plugin documentation here: https://mondeja.github.io/mkdocs-mdpo-plugin

You can access to the mkdocs-mdpo-plugin documentation here: https://mondeja.github.io/mkdocs-mdpo-plugin
msgid ""
"You can access to the mkdocs-mdpo-plugin documentation here: "
"https://mondeja.github.io/mkdocs-mdpo-plugin"
msgstr ""
"Puedes acceder a la documentación de mkdocs-mdpo-plugin aquí: "
"https://mondeja.github.io/mkdocs-mdpo-plugin/es"

pymdownx.mark

mark me

==mark me==
msgid "==mark me=="
msgstr "==marcame=="

pymdownx.progressbar

You must let one blank line between each progress bar.

0%

45%

100%

[=0% "0%"]

[=45% "45%"]

[=100% "100%"]
msgid "[=0% \"0%\"]"
msgstr "[=0% \"vacío\"]"

msgid "[=45% \"45%\"]"
msgstr "[=45% \"45 por ciento\"]"

msgid "[=100% \"100%\"]"
msgstr "[=100% \"lleno\"]"

pymdownx.smartsymbols

Here are some symbols: ™ © ®

Here are some symbols: (tm) (c) (r)
msgid "Here are some symbols: (tm) (c) (r)"
msgstr "Aquí hay algunos símbolos: (tm) (c) (r)"

pymdownx.snippets

Some inserted content from another file.

\--8<-- "docs/file-to-be-inserted.txt"
msgid "Some inserted content."
msgstr "Algo de contenido insertado."

pymdownx.tabbed

Tab content

=== "Output"

    Tab content
msgid "Output"
msgstr "Salida"

msgid "Tab content"
msgstr "Contenido de pestaña"
Warning

Some content of certain extensions placed inside tabs will not be translated.

pymdownx.tasklist

  • Task 1
    • Task A
    • Task B more text
      • Task δ
      • Task ε
      • Task ζ
    • Task C
  • Task 2
  • Task 3
- [X] Task 1
    * [X] Task A
    * [ ] Task B
        more text
        + [x] Task δ
        + [ ] Task ε
        + [x] Task ζ
    * [X] Task C
- [ ] Task 2
- [ ] Task 3
msgid "Task 1"
msgstr ""

msgid "Task A"
msgstr ""

msgid "Task B more text"
msgstr ""

msgid "Task δ"
msgstr ""

msgid "Task ε"
msgstr ""

msgid "Task ζ"
msgstr ""

msgid "Task C"
msgstr ""

msgid "Task 2"
msgstr ""

msgid "Task 3"
msgstr ""

pymdownx.tilde

Delete me

CH3CH2OH

~~Delete me~~

CH~3~CH~2~OH
msgid "~~Delete me~~"
msgstr "~~Elimíname~~"

msgid "CH~3~CH~2~OH"
msgstr "H~2~O"