diff --git a/docs/authoring/code-blocks.md b/docs/authoring/code-blocks.md index 589038c..aedd15a 100644 --- a/docs/authoring/code-blocks.md +++ b/docs/authoring/code-blocks.md @@ -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 = {} diff --git a/docs/authoring/content-tabs.md b/docs/authoring/content-tabs.md index c4620bb..78d2622 100644 --- a/docs/authoring/content-tabs.md +++ b/docs/authoring/content-tabs.md @@ -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`" @@ -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`" diff --git a/docs/authoring/diagrams.md b/docs/authoring/diagrams.md index 9f28e24..019ca2a 100644 --- a/docs/authoring/diagrams.md +++ b/docs/authoring/diagrams.md @@ -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`" diff --git a/docs/authoring/icons-emojis.md b/docs/authoring/icons-emojis.md index bd1980b..8465e93 100644 --- a/docs/authoring/icons-emojis.md +++ b/docs/authoring/icons-emojis.md @@ -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`" diff --git a/docs/authoring/lists.md b/docs/authoring/lists.md index 0311ed2..81788b7 100644 --- a/docs/authoring/lists.md +++ b/docs/authoring/lists.md @@ -22,9 +22,7 @@ your configuration: ``` toml [project.markdown_extensions] def_list = {} - pymdownx.tasklist = { - custom_checkbox = true - } + pymdownx.tasklist.custom_checkbox = true ``` === "`mkdocs.yml`" diff --git a/docs/authoring/math.md b/docs/authoring/math.md index 38104f1..1a77ea3 100644 --- a/docs/authoring/math.md +++ b/docs/authoring/math.md @@ -62,9 +62,7 @@ to your configuration: ] [project.markdown_extensions] - pymdownx.arithmatex = { - generic = true, - } + pymdownx.arithmatex.generic = true ``` === "`mkdocs.yml`" @@ -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`" diff --git a/docs/authoring/tooltips.md b/docs/authoring/tooltips.md index 2448958..e35b0eb 100644 --- a/docs/authoring/tooltips.md +++ b/docs/authoring/tooltips.md @@ -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`" diff --git a/docs/customization.md b/docs/customization.md index 1db7045..05154ea 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -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" }, ] ``` @@ -158,10 +155,7 @@ the `async` case: ``` toml [project] extra_javascript = [ - { - path = "javascripts/extra.js", - async = true, - }, + { path = "javascripts/extra.js", async = true }, ] ``` diff --git a/docs/setup/data-privacy.md b/docs/setup/data-privacy.md index fc20c07..7b0744a 100644 --- a/docs/setup/data-privacy.md +++ b/docs/setup/data-privacy.md @@ -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`" @@ -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, diff --git a/docs/setup/extensions/about.md b/docs/setup/extensions/about.md index 516a1f6..19958f6 100644 --- a/docs/setup/extensions/about.md +++ b/docs/setup/extensions/about.md @@ -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 = {} ``` diff --git a/docs/setup/extensions/glightbox.md b/docs/setup/extensions/glightbox.md index 47740b7..1a04931 100644 --- a/docs/setup/extensions/glightbox.md +++ b/docs/setup/extensions/glightbox.md @@ -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`" @@ -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`" @@ -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`" @@ -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`" @@ -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`" @@ -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`" @@ -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`" diff --git a/docs/setup/extensions/macros.md b/docs/setup/extensions/macros.md index 5248975..5b87400 100644 --- a/docs/setup/extensions/macros.md +++ b/docs/setup/extensions/macros.md @@ -46,9 +46,7 @@ Name of a Python module to load for defining variables, macros, and filters (def ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - module_name = "macros", - } + zensical.extensions.macros.module_name = "macros" ``` === "`mkdocs.yml`" @@ -67,11 +65,9 @@ List of additional importable module names (pluglets) to load on top of [`module ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - modules = [ - "my_package.macros", - ], - } + zensical.extensions.macros.modules = [ + "my_package.macros", + ] ``` === "`mkdocs.yml`" @@ -91,22 +87,16 @@ YAML files whose contents are merged into the template variables. A list of file ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - include_yaml = [ - "data/variables.yml", - ], - } + zensical.extensions.macros.include_yaml = [ + "data/variables.yml", + ] ``` To assign file contents to a named variable: ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - include_yaml = { - team = "data/team.yml" - } - } + zensical.extensions.macros.include_yaml.team = "data/team.yml" ``` === "`mkdocs.yml`" @@ -135,9 +125,7 @@ Directory used as a Jinja2 template loader, enabling `{% include %}` tags in pag ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - include_dir = "includes", - } + zensical.extensions.macros.include_dir = "includes" ``` === "`mkdocs.yml`" @@ -156,9 +144,7 @@ When `true`, all pages are rendered as Jinja2 templates. When `false`, only page ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - render_by_default = false, - } + zensical.extensions.macros.render_by_default = false ``` === "`mkdocs.yml`" @@ -177,9 +163,7 @@ When `true`, render errors cause the build to fail. When `false`, pages that fai ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - on_error_fail = true, - } + zensical.extensions.macros.on_error_fail = true ``` === "`mkdocs.yml`" @@ -198,9 +182,7 @@ How undefined template variables are handled. When set to `"keep"`, undefined ex ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - on_undefined = "strict", - } + zensical.extensions.macros.on_undefined = "strict" ``` === "`mkdocs.yml`" @@ -219,9 +201,7 @@ Opening delimiter for Jinja2 block tags (default: `{%`). ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - j2_block_start_string = "<%", - } + zensical.extensions.macros.j2_block_start_string = "<%" ``` === "`mkdocs.yml`" @@ -240,9 +220,7 @@ Closing delimiter for Jinja2 block tags (default: `%}`). ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - j2_block_end_string = "%>", - } + zensical.extensions.macros.j2_block_end_string = "%>" ``` === "`mkdocs.yml`" @@ -261,9 +239,7 @@ Opening delimiter for Jinja2 variable expressions (default: `{{`). ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - j2_variable_start_string = "<<", - } + zensical.extensions.macros.j2_variable_start_string = "<<" ``` === "`mkdocs.yml`" @@ -282,9 +258,7 @@ Closing delimiter for Jinja2 variable expressions (default: `}}`). ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - j2_variable_end_string = ">>", - } + zensical.extensions.macros.j2_variable_end_string = ">>" ``` === "`mkdocs.yml`" @@ -303,9 +277,7 @@ Opening delimiter for Jinja2 comments (default: `{#`). ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - j2_comment_start_string = "<#", - } + zensical.extensions.macros.j2_comment_start_string = "<#" ``` === "`mkdocs.yml`" @@ -324,9 +296,7 @@ Closing delimiter for Jinja2 comments (default: `#}`). ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - j2_comment_end_string = "#>", - } + zensical.extensions.macros.j2_comment_end_string = "#>" ``` === "`mkdocs.yml`" @@ -345,11 +315,9 @@ List of [Jinja2 extensions] to be loaded into the template environment. The defa ``` toml [project.markdown_extensions] - zensical.extensions.macros = { - j2_extensions = [ - "jinja2.ext.do", - ], - } + zensical.extensions.macros.j2_extensions = [ + "jinja2.ext.do", + ] ``` === "`mkdocs.yml`" diff --git a/docs/setup/extensions/mkdocstrings.md b/docs/setup/extensions/mkdocstrings.md index f92766d..fd694d3 100644 --- a/docs/setup/extensions/mkdocstrings.md +++ b/docs/setup/extensions/mkdocstrings.md @@ -42,11 +42,9 @@ Configure mkdocstrings as a plugin: [project.plugins.mkdocstrings.handlers.python] inventories = ["https://docs.python.org/3/objects.inv"] paths = ["src"] - options = { - docstring_style = "google", - inherited_members = true, - show_source = false, - } + options.docstring_style = "google" + options.inherited_members = true + options.show_source = false ``` === "`mkdocs.yml`" diff --git a/docs/setup/extensions/python-markdown-extensions.md b/docs/setup/extensions/python-markdown-extensions.md index a32c450..18601a5 100644 --- a/docs/setup/extensions/python-markdown-extensions.md +++ b/docs/setup/extensions/python-markdown-extensions.md @@ -25,9 +25,7 @@ mathematical typesetting. Enable it via: ``` toml [project.markdown_extensions] - pymdownx.arithmatex = { - generic = true, - } + pymdownx.arithmatex.generic = true ``` === "`mkdocs.yml`" @@ -189,10 +187,8 @@ in `*.svg` file format into the resulting HTML page. Enable it via: ``` toml [project.markdown_extensions] - pymdownx.emoji = { - emoji_generator = "zensical.extensions.emoji.to_svg", - emoji_index = "zensical.extensions.emoji.twemoji", # (1)! - } + pymdownx.emoji.emoji_generator = "zensical.extensions.emoji.to_svg" + pymdownx.emoji.emoji_index = "zensical.extensions.emoji.twemoji" # (1)! ``` 1. [Python Markdown Extensions] uses the `pymdownx` namespace, but in order to @@ -223,9 +219,7 @@ recommended due to [restrictions in licensing][Emoji index]: ``` toml [project.markdown_extensions] - pymdownx.emoji = { - emoji_index = "zensical.extensions.emoji.twemoji", - } + pymdownx.emoji.emoji_index = "zensical.extensions.emoji.twemoji" ``` === "`mkdocs.yml`" @@ -245,9 +239,7 @@ that icons can only be used together with the `to_svg` configuration: ``` toml [project.markdown_extensions] - pymdownx.emoji = { - emoji_generator = "zensical.extensions.emoji.to_svg", - } + pymdownx.emoji.emoji_generator = "zensical.extensions.emoji.to_svg" ``` === "`mkdocs.yml`" @@ -268,13 +260,11 @@ Markdown or the configuration, which is explained in more detail in the ``` toml [project.markdown_extensions] - pymdownx.emoji = { - emoji_generator = "zensical.extensions.emoji.to_svg", - emoji_index = "zensical.extensions.emoji.twemoji", - options.custom_icons = [ - "overrides/.icons", - ], - } + pymdownx.emoji.emoji_generator = "zensical.extensions.emoji.to_svg" + pymdownx.emoji.emoji_index = "zensical.extensions.emoji.twemoji" + pymdownx.emoji.options.custom_icons = [ + "overrides/.icons", + ] ``` === "`mkdocs.yml`" @@ -309,9 +299,7 @@ The [Highlight] extension adds support for syntax highlighting of code blocks ``` toml [project.markdown_extensions] - pymdownx.highlight = { - anchor_linenums = true, - } + pymdownx.highlight.anchor_linenums = true pymdownx.superfences = {} ``` @@ -344,9 +332,7 @@ function. Enable via: ``` toml [project.markdown_extensions] - pymdownx.highlight = { - pygments_lang_class = true, - } + pymdownx.highlight.pygments_lang_class = true ``` === "`mkdocs.yml`" @@ -366,9 +352,7 @@ the name of the language being used, e.g. `Python` is printed for a `py` block: ``` toml [project.markdown_extensions] - pymdownx.highlight = { - auto_title = true, - } + pymdownx.highlight.auto_title = true ``` === "`mkdocs.yml`" @@ -390,9 +374,7 @@ which also contains some tips on working with line numbers: ``` toml [project.markdown_extensions] - pymdownx.highlight = { - linenums = true, - } + pymdownx.highlight.linenums = true ``` === "`mkdocs.yml`" @@ -414,9 +396,7 @@ line itself: ``` toml [project.markdown_extensions] - pymdownx.highlight = { - linenums_style = "pymdownx-inline", - } + pymdownx.highlight.linenums_style = "pymdownx-inline" ``` === "`mkdocs.yml`" @@ -443,9 +423,7 @@ with anchor links, so they can be hyperlinked and shared more easily: ``` toml [project.markdown_extensions] - pymdownx.highlight = { - anchor_linenums = true, - } + pymdownx.highlight.anchor_linenums = true ``` === "`mkdocs.yml`" @@ -465,9 +443,7 @@ which is essential for features like line highlighting to work correctly: ``` toml [project.markdown_extensions] - pymdownx.highlight = { - line_spans = "__span", - } + pymdownx.highlight.line_spans = "__span" ``` === "`mkdocs.yml`" @@ -632,15 +608,9 @@ the definitions of [Mermaid.js] diagrams to be interpreted in the browser: ``` 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`" @@ -681,10 +651,8 @@ related content and code blocks under accessible tabs. Enable it via: ``` toml [project.markdown_extensions] - pymdownx.tabbed = { - alternate_style = true, - combine_header_slug = true, - } + pymdownx.tabbed.alternate_style = true + pymdownx.tabbed.combine_header_slug = true ``` === "`mkdocs.yml`" @@ -707,9 +675,7 @@ behavior on mobile viewports], and is the only supported style: ``` toml [project.markdown_extensions] - pymdownx.tabbed = { - alternate_style = true, - } + pymdownx.tabbed.alternate_style = true ``` === "`mkdocs.yml`" @@ -729,9 +695,7 @@ prepends the id of the header to the `id` of the tab: ``` toml [project.markdown_extensions] - pymdownx.tabbed = { - combine_header_slug = true, - } + pymdownx.tabbed.combine_header_slug = true ``` === "`mkdocs.yml`" @@ -753,12 +717,8 @@ Markdown Extensions][Slugs]. To produce all-lowercase slugs: ``` 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`" @@ -777,11 +737,7 @@ In order to retain the case of the input: ``` toml [project.markdown_extensions] - pymdownx.tabbed = { - slugify = { - object = "pymdownx.slugs.slugify" - }, - } + pymdownx.tabbed.slugify.object = "pymdownx.slugs.slugify" ``` === "`mkdocs.yml`" @@ -812,9 +768,7 @@ conventions. Enable it via: ``` toml [project.markdown_extensions] - pymdownx.tasklist = { - custom_checkbox = true, - } + pymdownx.tasklist.custom_checkbox = true ``` === "`mkdocs.yml`" @@ -836,9 +790,7 @@ checkbox styles with beautiful icons, and is therefore recommended: ``` toml [project.markdown_extensions] - pymdownx.tasklist = { - custom_checkbox = true, - } + pymdownx.tasklist.custom_checkbox = true ``` === "`mkdocs.yml`" @@ -859,9 +811,7 @@ experience perspective: ``` toml [project.markdown_extensions] - pymdownx.tasklist = { - clickable_checkbox = true, - } + pymdownx.tasklist.clickable_checkbox = true ``` === "`mkdocs.yml`" diff --git a/docs/setup/extensions/python-markdown.md b/docs/setup/extensions/python-markdown.md index 68fe0d9..d4fab47 100644 --- a/docs/setup/extensions/python-markdown.md +++ b/docs/setup/extensions/python-markdown.md @@ -193,9 +193,7 @@ page. Enable it via: ``` toml [project.markdown_extensions] - toc = { - permalink = true, - } + toc.permalink = true ``` === "`mkdocs.yml`" @@ -218,9 +216,7 @@ the [site language]. Set the title explicitly via: ``` toml [project.markdown_extensions] - toc = { - title = "On this page", - } + toc.title = "On this page" ``` === "`mkdocs.yml`" @@ -245,9 +241,7 @@ or string like so: ``` toml [project.markdown_extensions] - toc = { - permalink = "⚓︎", - } + toc.permalink = "⚓︎" ``` === "`mkdocs.yml`" @@ -269,9 +263,7 @@ section itself: ``` toml [project.markdown_extensions] - toc = { - permalink_title = "Anchor link to this section", - } + toc.permalink_title = "Anchor link to this section" ``` === "`mkdocs.yml`" @@ -293,12 +285,8 @@ Python Markdown Extensions][Slugs]: ``` toml [project.markdown_extensions] - toc = { - slugify = { - object = "pymdownx.slugs.slugify", - kwds.case = "lower", - }, - } + toc.slugify.object = "pymdownx.slugs.slugify" + toc.slugify.kwds.case = "lower" ``` === "`mkdocs.yml`" @@ -321,9 +309,7 @@ headings to decrease the length of the table of contents: ``` toml [project.markdown_extensions] - toc = { - toc_depth = 3, - } + toc.toc_depth = 3 ``` === "`mkdocs.yml`" @@ -340,9 +326,7 @@ To remove the table of contents altogether: ``` toml [project.markdown_extensions] - toc = { - toc_depth = 0, - } + toc.toc_depth = 0 ``` === "`mkdocs.yml`" diff --git a/docs/setup/logo-and-icons.md b/docs/setup/logo-and-icons.md index fb6a158..c8121b5 100644 --- a/docs/setup/logo-and-icons.md +++ b/docs/setup/logo-and-icons.md @@ -160,13 +160,11 @@ your project documentation. The structure of your project should look like this: custom_dir = "overrides" [project.markdown_extensions] - pymdownx.emoji = { - emoji_generator = "zensical.extensions.emoji.to_svg", - emoji_index = "zensical.extensions.emoji.twemoji", - options.custom_icons = [ - "overrides/.icons", - ], - } + pymdownx.emoji.emoji_generator = "zensical.extensions.emoji.to_svg" + pymdownx.emoji.emoji_index = "zensical.extensions.emoji.twemoji" + pymdownx.emoji.options.custom_icons = [ + "overrides/.icons", + ] ``` === "`mkdocs.yml`" diff --git a/docs/setup/navigation.md b/docs/setup/navigation.md index 832546e..5f8cf56 100644 --- a/docs/setup/navigation.md +++ b/docs/setup/navigation.md @@ -246,14 +246,10 @@ instant previews on a per-page or per-section level for your documentation: === "`zensical.toml`" ``` toml - [project.markdown_extensions] - zensical.extensions.preview.configurations = [ - { - targets.include = [ - "customization.md", - "setup/extensions/*", - ] - }, + [[project.markdown_extensions.zensical.extensions.preview.configurations]] + targets.include = [ + "customization.md", + "setup/extensions/*", ] ``` @@ -278,19 +274,11 @@ extensions in the setup guide. === "`zensical.toml`" ``` toml - [project.markdown_extensions] - zensical.extensions.preview.configurations = [ - { - sources = { - include = [], - exclude = [], - }, # (1)! - targets = { - include = [], - exclude = [], - }, # (2)! - }, - ] + [[project.markdown_extensions.zensical.extensions.preview.configurations]] + sources.include = [] # (1)! + sources.exclude = [] + targets.include = [] # (2)! + targets.exclude = [] ``` === "`mkdocs.yml`" diff --git a/docs/setup/offline.md b/docs/setup/offline.md index cf16d90..2bdfd80 100644 --- a/docs/setup/offline.md +++ b/docs/setup/offline.md @@ -92,12 +92,7 @@ or ``` toml [project.extra] polyfills = [ - { - path = "js/iframe-worker-shim.js", - type = "text/javascript", - async = false, - defer = false, - }, + { path = "js/iframe-worker-shim.js", type = "text/javascript", async = false, defer = false }, ] ```