Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/authoring/code-blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@ following lines to your configuration:

``` toml
[project.markdown_extensions]
pymdownx.highlight = {
anchor_linenums = true,
line_spans = "__span",
pygments_lang_class = true,
}
pymdownx.highlight.anchor_linenums = true
pymdownx.highlight.line_spans = "__span"
pymdownx.highlight.pygments_lang_class = true
pymdownx.inlinehilite = {}
pymdownx.snippets = {}
pymdownx.superfences = {}
Expand Down
12 changes: 3 additions & 9 deletions docs/authoring/content-tabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ following lines to your configuration file:
``` toml
[project.markdown_extensions]
pymdownx.superfences = {}
pymdownx.tabbed = {
alternate_style = true
}
pymdownx.tabbed.alternate_style = true
```

=== "`mkdocs.yml`"
Expand Down Expand Up @@ -71,12 +69,8 @@ function with the following lines:

``` toml
[project.markdown_extensions]
pymdownx.tabbed = {
slugify = {
object = "pymdownx.slugs.slugify",
kwds.case = "lower",
}
}
pymdownx.tabbed.slugify.object = "pymdownx.slugs.slugify"
pymdownx.tabbed.slugify.kwds.case = "lower"
```

=== "`mkdocs.yml`"
Expand Down
12 changes: 3 additions & 9 deletions docs/authoring/diagrams.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,9 @@ will automatically initialize the JavaScript runtime when a page includes a

``` toml
[project.markdown_extensions]
pymdownx.superfences = {
custom_fences = [
{
name = "mermaid",
class = "mermaid",
format = "pymdownx.superfences.fence_code_format",
},
],
}
pymdownx.superfences.custom_fences = [
{ name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
]
```

=== "`mkdocs.yml`"
Expand Down
6 changes: 2 additions & 4 deletions docs/authoring/icons-emojis.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,8 @@ shortcodes. Add the following lines to your configuration:
``` toml
[project.markdown_extensions]
attr_list = {}
pymdownx.emoji = {
emoji_generator = "zensical.extensions.emoji.to_svg",
emoji_index = "zensical.extensions.emoji.twemoji",
}
pymdownx.emoji.emoji_generator = "zensical.extensions.emoji.to_svg"
pymdownx.emoji.emoji_index = "zensical.extensions.emoji.twemoji"
```

=== "`mkdocs.yml`"
Expand Down
4 changes: 1 addition & 3 deletions docs/authoring/lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ your configuration:
``` toml
[project.markdown_extensions]
def_list = {}
pymdownx.tasklist = {
custom_checkbox = true
}
pymdownx.tasklist.custom_checkbox = true
```

=== "`mkdocs.yml`"
Expand Down
8 changes: 2 additions & 6 deletions docs/authoring/math.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,7 @@ to your configuration:
]

[project.markdown_extensions]
pymdownx.arithmatex = {
generic = true,
}
pymdownx.arithmatex.generic = true
```

=== "`mkdocs.yml`"
Expand Down Expand Up @@ -138,9 +136,7 @@ supports a subset of LaTeX syntax and can render math to HTML and SVG. To use
]

[project.markdown_extensions]
pymdownx.arithmatex = {
generic = true,
}
pymdownx.arithmatex.generic = true
```

=== "`mkdocs.yml`"
Expand Down
6 changes: 3 additions & 3 deletions docs/authoring/tooltips.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,9 @@ pages with the following configuration:

``` toml
[project.markdown_extensions]
pymdownx.snippets = {
auto_append = ["includes/abbreviations.md"],
}
pymdownx.snippets.auto_append = [
"includes/abbreviations.md",
]
```

=== "`mkdocs.yml`"
Expand Down
10 changes: 2 additions & 8 deletions docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,7 @@ to be loaded as a module:
``` toml
[project]
extra_javascript = [
{
path = "javascripts/extra.js",
type = "module",
},
{ path = "javascripts/extra.js", type = "module" },
]
```

Expand All @@ -158,10 +155,7 @@ the `async` case:
``` toml
[project]
extra_javascript = [
{
path = "javascripts/extra.js",
async = true,
},
{ path = "javascripts/extra.js", async = true },
]
```

Expand Down
12 changes: 4 additions & 8 deletions docs/setup/data-privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,8 @@ The following properties are available:

``` toml
[project.extra.consent.cookies]
analytics = {
name = "Google Analytics",
checked = false,
}
analytics.name = "Google Analytics"
analytics.checked = false
```

=== "`mkdocs.yml`"
Expand All @@ -124,10 +122,8 @@ The following properties are available:

``` toml
[project.extra.consent.cookies]
analytics = {
name = "Google Analytics", # (1)!
custom = "Custom cookie",
}
analytics.name = "Google Analytics" # (1)!
analytics.custom = "Custom cookie"
```

1. If you define a custom cookie as part of the `cookies` property,
Expand Down
44 changes: 13 additions & 31 deletions docs/setup/extensions/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,45 +84,27 @@ default configuration is written to the generated `zensical.toml` file:
def_list = {}
footnotes = {}
md_in_html = {}
toc = {
permalink = true,
}
pymdownx.arithmatex = {
generic = true,
}
toc.permalink = true
pymdownx.arithmatex.generic = true
pymdownx.betterem = {}
pymdownx.caret = {}
pymdownx.details = {}
pymdownx.emoji = {
emoji_generator = "zensical.extensions.emoji.to_svg",
emoji_index = "zensical.extensions.emoji.twemoji",
}
pymdownx.highlight = {
anchor_linenums = true,
line_spans = "__span",
pygments_lang_class = true,
}
pymdownx.emoji.emoji_generator = "zensical.extensions.emoji.to_svg"
pymdownx.emoji.emoji_index = "zensical.extensions.emoji.twemoji"
pymdownx.highlight.anchor_linenums = true
pymdownx.highlight.line_spans = "__span"
pymdownx.highlight.pygments_lang_class = true
pymdownx.inlinehilite = {}
pymdownx.keys = {}
pymdownx.magiclink = {}
pymdownx.mark = {}
pymdownx.smartsymbols = {}
pymdownx.superfences = {
custom_fences = [
{
name = "mermaid",
class = "mermaid",
format = "pymdownx.superfences.fence_code_format",
},
],
}
pymdownx.tabbed = {
alternate_style = true,
combine_header_slug = true,
}
pymdownx.tasklist = {
custom_checkbox = true,
}
pymdownx.superfences.custom_fences = [
{ name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
]
pymdownx.tabbed.alternate_style = true
pymdownx.tabbed.combine_header_slug = true
pymdownx.tasklist.custom_checkbox = true
pymdownx.tilde = {}
```

Expand Down
32 changes: 9 additions & 23 deletions docs/setup/extensions/glightbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,7 @@ When `true`, images are wrapped automatically, unless they have the `off-glb` CS

``` toml
[project.markdown_extensions]
zensical.extensions.glightbox = {
auto = false,
}
zensical.extensions.glightbox.auto = false
```

=== "`mkdocs.yml`"
Expand All @@ -54,9 +52,7 @@ When set to `true`, images for light and dark modes are grouped into separate ga

``` toml
[project.markdown_extensions]
zensical.extensions.glightbox = {
auto_themed = true,
}
zensical.extensions.glightbox.auto_themed = true
```

=== "`mkdocs.yml`"
Expand All @@ -75,9 +71,7 @@ Width of the lightbox overlay (default: `auto`). Accepts CSS units (`px`, `%`, `

``` toml
[project.markdown_extensions]
zensical.extensions.glightbox = {
width = "800px",
}
zensical.extensions.glightbox.width = "800px"
```

=== "`mkdocs.yml`"
Expand All @@ -96,9 +90,7 @@ Height of the lightbox overlay (default: `auto`). Accepts CSS units (`px`, `%`,

``` toml
[project.markdown_extensions]
zensical.extensions.glightbox = {
height = "600px",
}
zensical.extensions.glightbox.height = "600px"
```

=== "`mkdocs.yml`"
Expand All @@ -117,11 +109,9 @@ List of image CSS classes to exclude from automatic wrapping. The default value

``` toml
[project.markdown_extensions]
zensical.extensions.glightbox = {
skip_classes = [
"extra-class-to-exclude",
],
}
zensical.extensions.glightbox.skip_classes = [
"extra-class-to-exclude",
]
```

=== "`mkdocs.yml`"
Expand All @@ -141,9 +131,7 @@ When set to `true`, the image `alt` attribute is used as a caption when no expli

``` toml
[project.markdown_extensions]
zensical.extensions.glightbox = {
auto_caption = true,
}
zensical.extensions.glightbox.auto_caption = true
```

=== "`mkdocs.yml`"
Expand All @@ -162,9 +150,7 @@ Default caption position for images (default: `bottom`). Valid values: `bottom`,

``` toml
[project.markdown_extensions]
zensical.extensions.glightbox = {
caption_position = "right",
}
zensical.extensions.glightbox.caption_position = "right"
```

=== "`mkdocs.yml`"
Expand Down
Loading