Skip to content

docs: use TOML 1.1 inline tables (#104) #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
alexvoss wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

docs: use TOML 1.1 inline tables (#104) #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
276cf48
docs: use TOML 1.1 inline tables to simplify repeated pymdownx snippets
alexvoss Jul 7, 2026
368e476
docs: apply TOML 1.1 inline tables to remaining markdown_extensions s…
alexvoss Jul 7, 2026
d7c6bfd
fix code block start lines
alexvoss Jul 11, 2026
7a64725
refator: using pymdownx prefix in extensions
alexvoss Jul 14, 2026
d2d1495
fix: duplicate TOML table
alexvoss Jul 18, 2026
48f417b
fix: separate slugify from tabbed
alexvoss Jul 18, 2026
98dacf6
fix: separate slugify option from toc extension
alexvoss Jul 18, 2026
9da4a3e
fix: separate configurations from preview
alexvoss Jul 18, 2026
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
7 changes: 4 additions & 3 deletions docs/authoring/admonitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ configuration:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.admonition]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.superfences]
[project.markdown_extensions]
admonition = {}
pymdownx.details = {}
pymdownx.superfences = {}
```

=== "`mkdocs.yml`"
Expand Down
3 changes: 2 additions & 1 deletion docs/authoring/buttons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ following lines to your configuration:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.attr_list]
[project.markdown_extensions]
attr_list = {}
```

=== "`mkdocs.yml`"
Expand Down
16 changes: 9 additions & 7 deletions docs/authoring/code-blocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,15 @@ following lines to your configuration:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.snippets]
[project.markdown_extensions.pymdownx.superfences]
[project.markdown_extensions]
pymdownx.highlight = {
anchor_linenums = true,
line_spans = "__span",
pygments_lang_class = true,
}
pymdownx.inlinehilite = {}
pymdownx.snippets = {}
pymdownx.superfences = {}
```

=== "`mkdocs.yml`"
Expand Down
14 changes: 8 additions & 6 deletions docs/authoring/content-tabs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ following lines to your configuration file:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.pymdownx.superfences]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
[project.markdown_extensions]
pymdownx.superfences = {}
pymdownx.tabbed = { alternate_style = true }
```

=== "`mkdocs.yml`"
Expand Down Expand Up @@ -69,9 +69,11 @@ function with the following lines:
=== "`zensical.toml`"

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

@alexvoss alexvoss Jul 18, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do wonder if this should be pymdownx.tabbed = { slugify = ...? That would be consistent with the way the superfences one is done (see below)

@pawamoy pawamoy Jul 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm. Yeah maybe it's better to stay consistent and only keep extension names as keys 🤔

object = "pymdownx.slugs.slugify",
kwds = { case = "lower" },
}
```

=== "`mkdocs.yml`"
Expand Down
3 changes: 2 additions & 1 deletion docs/authoring/data-tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ configuration file:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.tables]
[project.markdown_extensions]
tables = {}
```

=== "`mkdocs.yml`"
Expand Down
14 changes: 10 additions & 4 deletions docs/authoring/diagrams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,16 @@ will automatically initialize the JavaScript runtime when a page includes a
=== "`zensical.toml`"

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

=== "`mkdocs.yml`"
Expand Down
3 changes: 2 additions & 1 deletion docs/authoring/footnotes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ your configuration:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.footnotes]
[project.markdown_extensions]
footnotes = {}
```

=== "`mkdocs.yml`"
Expand Down
9 changes: 5 additions & 4 deletions docs/authoring/formatting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@ configuration:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.keys]
[project.markdown_extensions.pymdownx.mark]
[project.markdown_extensions.pymdownx.tilde]
[project.markdown_extensions]
pymdownx.caret = {}
pymdownx.keys = {}
pymdownx.mark = {}
pymdownx.tilde = {}
```

=== "`mkdocs.yml`"
Expand Down
5 changes: 3 additions & 2 deletions docs/authoring/grids.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ to your configuration:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.attr_list]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions]
attr_list = {}
md_in_html = {}
```

=== "`mkdocs.yml`"
Expand Down
5 changes: 3 additions & 2 deletions docs/authoring/icons-emojis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ shortcodes. Add the following lines to your configuration:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.attr_list]
[project.markdown_extensions.pymdownx.emoji]
[project.markdown_extensions]
attr_list = {}
pymdownx.emoji = {}
```

=== "`mkdocs.yml`"
Expand Down
7 changes: 4 additions & 3 deletions docs/authoring/images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ following lines to your configuration:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.attr_list]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.pymdownx.blocks.caption]
[project.markdown_extensions]
attr_list = {}
md_in_html = {}
pymdownx.blocks.caption = {}

@alexvoss alexvoss Jul 18, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case, I would accept the edit as caption is not an option for the blocks extension but an extension in the blocks group of extensions - right?

@pawamoy pawamoy Jul 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right!

```

=== "`mkdocs.yml`"
Expand Down
6 changes: 3 additions & 3 deletions docs/authoring/lists.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ your configuration:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.def_list]
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
[project.markdown_extensions]
def_list = {}
pymdownx.tasklist = { custom_checkbox = true }
```

=== "`mkdocs.yml`"
Expand Down
9 changes: 5 additions & 4 deletions docs/authoring/math.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,9 @@ to your configuration:
"javascripts/mathjax.js",
"https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js"
]
[project.markdown_extensions.pymdownx.arithmatex]
generic = true

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

=== "`mkdocs.yml`"
Expand Down Expand Up @@ -143,8 +144,8 @@ supports a subset of LaTeX syntax and can render math to HTML and SVG. To use
"https://unpkg.com/katex@0/dist/katex.min.css"
]

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

=== "`mkdocs.yml`"
Expand Down
12 changes: 6 additions & 6 deletions docs/authoring/tooltips.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,10 @@ following line to your configuration:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.abbr]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.pymdownx.snippets]
[project.markdown_extensions]
abbr = {}
attr_list = {}
pymdownx.snippets = {}
```

=== "`mkdocs.yml`"
Expand Down Expand Up @@ -168,8 +169,8 @@ pages with the following configuration:
=== "`zensical.toml`"

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

=== "`mkdocs.yml`"
Expand All @@ -182,4 +183,3 @@ pages with the following configuration:
````

[auto-append]: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#auto-append-snippets

2 changes: 1 addition & 1 deletion docs/customization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ configuration:

=== "`zensical.toml`"

```toml
``` toml
[project.theme]
name = "my_theme"
```
Expand Down
75 changes: 39 additions & 36 deletions docs/setup/extensions/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,42 +111,45 @@ extensions are enabled by default:
=== "`zensical.toml`"

``` toml
[project.markdown_extensions.abbr]
[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.def_list]
[project.markdown_extensions.footnotes]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.toc]
permalink = true
[project.markdown_extensions.pymdownx.arithmatex]
generic = true
[project.markdown_extensions.pymdownx.betterem]
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.emoji]
emoji_generator = "zensical.extensions.emoji.to_svg"
emoji_index = "zensical.extensions.emoji.twemoji"
[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.keys]
[project.markdown_extensions.pymdownx.magiclink]
[project.markdown_extensions.pymdownx.mark]
[project.markdown_extensions.pymdownx.smartsymbols]
[project.markdown_extensions.pymdownx.superfences]
custom_fences = [
{ name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" }
]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
combine_header_slug = true
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
[project.markdown_extensions.pymdownx.tilde]

[project.markdown_extensions]
abbr = {}
admonition = {}
attr_list = {}
def_list = {}
footnotes = {}
md_in_html = {}
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.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.tilde = {}
```

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