content
Goals
%s
' % (language, class_name, options['opt'], html_escape(source))
```
--------------------------------
### Initialize Snippets Extension
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/snippets.md
Import the markdown library and initialize it with the 'pymdownx.snippets' extension.
```python
import markdown
md = markdown.Markdown(extensions=['pymdownx.snippets'])
```
--------------------------------
### Initialize Definition Blocks Extension
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/blocks/plugins/definition.md
Import the markdown library and initialize the Markdown instance with the `pymdownx.blocks.definition` extension. This is necessary if you are customizing meta-plugins.
```python
import markdown
md = markdown.Markdown(extensions=['pymdownx.blocks.definition'])
```
--------------------------------
### Emoji SVG Sprite HTML Output Example
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/emoji.md
Example HTML output for an emoji using the SVG sprite generator. It includes a class and a use element referencing the sprite.
```html
```
--------------------------------
### Initialize Arithmatex Extension
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/arithmatex.md
Import the markdown library and include 'pymdownx.arithmatex' in the extensions list to enable the Arithmatex functionality.
```py3
import markdown
md = markdown.Markdown(extensions=['pymdownx.arithmatex'])
```
--------------------------------
### Install Spell Checking Requirements and Aspell
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/about/development.md
Install Python dependencies for spell checking and the Aspell spell checker utility on a Linux system. This is a prerequisite for running the spell checker locally.
```bash
pip install -r requirements/docs.txt
sudo apt-get install aspell aspell-en
```
--------------------------------
### Basic Callout Syntax
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/quotes.md
Demonstrates the basic syntax for creating a callout using a blockquote with a specified type like 'note'.
```text
> [!note]
> Here is a note
```
--------------------------------
### HTML with Inline Styles and Event Handlers
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/tests/extensions/striphtml/striphtml.txt
This example demonstrates nested HTML spans with inline styles and an onclick event handler. The 'unquoted' attribute example shows an attribute value without quotes.
```html
link
Some text
```
--------------------------------
### Forcing Lowercase Alphabetic List with Block
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/fancylists.md
Uses a special Block to force a lowercase alphabetic list by setting `type=a`. This ensures the first list item is parsed as alphabetical, even if it starts with 'i'. The `start` attribute can be used to ignore the actual value of the first item.
```markdown
/// fancylists | type=a
i. item i
j. item j
///
```
```markdown
/// fancylists | type=a start=9
#. item i
#. item j
///
```
--------------------------------
### Math Environment Rendering with \begin{align*}...\end{align*}
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/tests/extensions/arithmatex/arithmatex (dumb dollar).txt
Renders multi-line mathematical equations using the \begin{align*}...\end{align*} environment. Use this for aligned equations.
```markdown
\begin{align*}
x + y & = z \in \left\{ -1, 1 \right\} \\
g + h & = l
\end{align*}
```
```markdown
\begin{align*} x + y & = z \in \left\{ -1, 1 \right\} \\
g + h & = l
\end{align*}
```
```markdown
\begin{align*}x + y & = z \in \left\{ -1, 1 \right\} \\
g + h & = l
\end{align*}
```
```markdown
\begin{align*}x + y & = z \in \left\{ -1, 1 \right\} \\
g + h & = l
\end{align*}
```
--------------------------------
### Initialize Admonition Extension
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/blocks/plugins/admonition.md
Import and initialize the Admonition extension for Markdown processing. Ensure the 'admonition' extension is disabled if migrating to avoid conflicts.
```python
import markdown
md = markdown.Markdown(extensions=['pymdownx.blocks.admonition'])
```
--------------------------------
### Initialize Python Markdown with B64 Extension
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/b64.md
Enable the B64 extension by including 'pymdownx.b64' in the extensions list when creating a Markdown instance.
```python
import markdown
md = markdown.Markdown(extensions=['pymdownx.b64'])
```
--------------------------------
### Use Dollar Sign
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/tests/extensions/arithmatex/arithmatex (generic).txt
Example of using dollar signs for inline math expressions.
```tex
$
$3.00 + $5.00 = $8.00
$
```
--------------------------------
### Enable Shorthand Syntax Options
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/magiclink.md
Enable `repo_url_shorthand` and `social_url_shorthand` in the extension options to activate shorthand syntax. Ensure `provider`, `user`, and `repo` are set for code repository providers to enable full shorthand capabilities.
```markdown
---
extensions:
- pymdownx.magiclink
- pymdownx.saneheaders
- markdown.extensions.attr_list
extension_configs:
pymdownx.magiclink:
repo_url_shortener: true
repo_url_shorthand: true
social_url_shorthand: true
social_url_shortener: true
user: facelessuser
repo: pymdown-extensions
---
@facelessuser
@x:x
```
--------------------------------
### Entity Relationship Diagram Example
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extras/mermaid.md
Use this for modeling database schemas. Define entities and their relationships.
```diagram
erDiagram
CUSTOMER ||--o{ ORDER : places
ORDER ||--|{ LINE-ITEM : contains
CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
```
--------------------------------
### Import Test Module
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/tests/extensions/superfences/superfences (no pygments).html
Demonstrates importing a test module.
```python
import test
```
--------------------------------
### Example with nested blocks in HTML wrapper
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/blocks/index.md
Presents nested blocks within an HTML wrapper, demonstrating how different fence counts are used to manage nesting levels.
```html
///// html | div.result
//// note | Some title
/// details | Summary
type: warning
content
///
Content
////
/////
```
--------------------------------
### Sequence Diagram Example
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extras/mermaid.md
Use this for illustrating interactions between participants over time. Define participants and message flows.
```diagram
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts prevail! John-->>Alice: Great! John->>Bob: How about you? Bob-->>John: Jolly good! ``` -------------------------------- ### Open Details Block (HTML Wrapper) Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/blocks/plugins/details.md Shows how to set a details block to be open by default when using an HTML wrapper. ```html //// details | Some summary open: True Some content //// ``` -------------------------------- ### Unexpected Blockquote in Code Source: https://github.com/facelessuser/pymdown-extensions/blob/main/tests/extensions/superfences/superfences (failures).txt A code block containing a line that starts with a blockquote marker, which can disrupt parsing. ```markdown Test will > break ``` -------------------------------- ### Get Gemoji Version Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/emoji.md Retrieve the version of the Gemoji index used by the extension. This is useful for compatibility checks. ```python import pymdownx.gemoji_db as gmdb >>> gmdb.version 'v3.0.1' ``` -------------------------------- ### Get EmojiOne Version Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/emoji.md Retrieve the version of the EmojiOne index used by the extension. This is useful for compatibility checks. ```python import pymdownx.emoji1_db as e1db >>> e1db.version 'v2.2.7' ``` -------------------------------- ### B64 Image Processing Example Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/b64.md Shows how B64 processes a standard Markdown image reference and converts it into an HTML
```
--------------------------------
### Configure SuperFences for Custom Math Fences
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/arithmatex.md
Configure SuperFences to create custom math fences. `pymdownx.arithmatex` does not need to be included as an extension when using this configuration.
```python
import pymdownx.arithmatex as arithmatex
extensions = [
"pymdownx.superfences"
]
extension_config = {
"pymdownx.superfences": {
"custom_fences": [
{"name": "math", "class": "arithmatex", "format": arithmatex.arithmatex_fenced_format(mode="generic")}
]
}
}
```
--------------------------------
### Invalid Code Block Example
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/tests/extensions/superfences/superfences (failures).txt
A code block that will not be recognized due to improper formatting or lack of surrounding context.
```markdown
This will not work.
```
--------------------------------
### Build Documentation Assets
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/about/development.md
Build the final documentation output, including packaging, minimizing, and revisioning scripts and stylesheets. This command also updates 'zensical.yml' with new file revisions.
```bash
npm run build
```
--------------------------------
### Blockquote Unalignment Example 1
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/tests/extensions/superfences/superfences (failures).txt
Demonstrates a code block within a blockquote where content indentation is inconsistent with the blockquote marker.
```markdown
>```
> Test
Will
break
```
--------------------------------
### Basic Definition Block HTML Output
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/blocks/plugins/definition.md
The `/// define` syntax renders as an HTML definition list. This example shows the equivalent HTML output for the basic definition block.
```html
//// define
Apple
- Pomaceous fruit of plants of the genus Malus in
the family Rosaceae.
////
```
--------------------------------
### Python Method Definition
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/tests/test_extensions/_snippets/indented.txt
Defines a simple Python method within a class. This is a basic example of method definition in Python.
```python
class SomeClass:
"""Docstring."""
# --8<-- [start: py-section]
def some_method(self, param):
"""Docstring."""
return param
# --8<-- [end: py-section]
```
--------------------------------
### Build Documentation for Spell Checking
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/about/development.md
Build the project documentation, including cleaning previous builds, in preparation for spell checking. This ensures the spell checker operates on the latest generated content.
```bash
python3 -m zensical build-f zensical.yml --clean
```
--------------------------------
### Basic Details Block Usage
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/blocks/plugins/details.md
Demonstrates the basic syntax for creating a collapsible details block with a summary.
```text
/// details | Some summary
Some content
///
```
--------------------------------
### Using a Custom Admonition Type
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/blocks/plugins/admonition.md
Example of using a custom admonition type ('some-custom-type') that has been registered via extension configuration.
```text
/// some-custom-type | Some title
Some content
///
```
--------------------------------
### Initialize FancyLists with SaneHeaders
Source: https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/markdown/extensions/fancylists.md
Initialize the Markdown parser with the 'fancylists' and 'saneheaders' extensions. SaneHeaders is required for generic ordered list styles.
```python
import markdown
# SaneHeaders required for generic ordered styles `#.` and `#)`
md = markdown.Markdown(extensions=['pymdownx.fancylists', 'pymdownx.saneheaders'])
```