Skip to content

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

Draft
alexvoss wants to merge 8 commits into
masterfrom
toml11
Draft

docs: use TOML 1.1 inline tables (#104)#146
alexvoss wants to merge 8 commits into
masterfrom
toml11

Conversation

@alexvoss

@alexvoss alexvoss commented Jul 7, 2026

Copy link
Copy Markdown
Member

Several TOML snippets used separate top-level tables for each sibling extension. This PR changes that, making use of new features of TOML 1.1.

The largest single change is in the default configuration.

We should probably also convert the bootstrap zensical.toml.

Some tidying up for line-length still needed as well as checking that nothing broke. Hence a draft PR for now.

alexvoss added 3 commits July 7, 2026 09:50
Several TOML snippets used a separate [project.markdown_extensions...]
table header for each sibling extension, mirroring a YAML conversion
rather than idiomatic TOML. Collapse these into a single parent table
with inline table values, taking advantage of TOML 1.1's newlines in
inline tables for the larger multi-key cases.

Closes #104
Signed-off-by: alexvoss <alex@corealization.com>
Signed-off-by: alexvoss <alex@corealization.com>
object = "pymdownx.slugs.slugify"
kwds = { case = "lower" }
[project.markdown_extensions]
pymdownx.tabbed.slugify = {

@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.

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

Comment thread docs/authoring/images.md
[project.markdown_extensions]
attr_list = {}
md_in_html = {}
pymdownx.blocks.caption = {}

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?

Signed-off-by: alexvoss <alex@corealization.com>
``` toml
[project.markdown_extensions.zensical.extensions.macros]
[project.markdown_extensions.zensical.extensions]
macros = {}

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.

To make this consistent with the pymdownx case, we should make this:

[project.markdown_extensions]
zensical.extensions.macros = {}

Correct? Anything that speaks against this? Either way, the Zensical extensions would come last in the list.

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

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.

To make this consistent with the pymdownx case, we should make this:

[project.markdown_extensions]
zensical.extensions.glightbox = {}

Correct? Anything that speaks against this? Either way, the Zensical extensions would come last in the list.

@@ -46,11 +46,11 @@ Configure mkdocstrings as a plugin:
[project.plugins.mkdocstrings.handlers.python]

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.

We only have mkdocstrings under plugins at the moment, right? If so then I would leave the table as it is.

alexvoss added 3 commits July 18, 2026 08:20
Signed-off-by: alexvoss <alex@corealization.com>
Signed-off-by: alexvoss <alex@corealization.com>
Signed-off-by: alexvoss <alex@corealization.com>
Comment thread docs/setup/navigation.md
sources.exclude = [...]
targets.include = [...]
targets.exclude = [...]
[project.markdown_extensions.zensical.extensions]

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.

zensical.extensions.preview to be consistent with pymdownx extensions?

@alexvoss
alexvoss requested a review from pawamoy July 18, 2026 06:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant