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
11 changes: 6 additions & 5 deletions docs/authoring/admonitions.md
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 All @@ -48,8 +49,8 @@ lines to your configuration:
=== "`zensical.toml`"

``` toml
[project.theme.icon]
admonition = {<type> = "<icon>"}
[project.theme.icon.admonition]
<type> = "<icon>"
```

??? example "Expand to show alternate icon sets"
Expand Down
3 changes: 2 additions & 1 deletion docs/authoring/buttons.md
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
42 changes: 27 additions & 15 deletions docs/authoring/code-blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,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 Expand Up @@ -64,7 +66,7 @@ your configuration to enable them globally:
``` toml
[project.theme]
features = [
"content.code.copy"
"content.code.copy",
]
```

Expand Down Expand Up @@ -113,7 +115,7 @@ to your configuration to enable it globally:
``` toml
[project.theme]
features = [
"content.code.select"
"content.code.select",
]
```

Expand Down Expand Up @@ -159,7 +161,7 @@ your configuration to enable them globally:
``` toml
[project.theme]
features = [
"content.code.annotate" # (1)!
"content.code.annotate", # (1)!
]
```

Expand Down Expand Up @@ -296,7 +298,9 @@ language of the block can be placed, e.g. for JavaScript in `#!js // ...` and
```` markdown title="Code block with annotation"
``` toml
[project.theme]
features = ["content.code.annotate"] # (1)!
features = [
"content.code.annotate", # (1)!
]
```

1. :man_raising_hand: I'm a code annotation! I can contain `code`, __formatted
Expand All @@ -307,7 +311,9 @@ features = ["content.code.annotate"] # (1)!

``` toml
[project.theme]
features = ["content.code.annotate"] # (1)!
features = [
"content.code.annotate", # (1)!
]
```

1. :man_raising_hand: I'm a code annotation! I can contain `code`, **formatted
Expand Down Expand Up @@ -505,7 +511,9 @@ a new color by using an [additional style sheet]:

``` toml
[project]
extra_css = ["stylesheets/extra.css"]
extra_css = [
"stylesheets/extra.css",
]
```

=== "`mkdocs.yml`"
Expand All @@ -531,7 +539,9 @@ override it as part of your [additional style sheet]:

``` toml
[project]
extra_css = ["stylesheets/extra.css"]
extra_css = [
"stylesheets/extra.css",
]
```

=== "`mkdocs.yml`"
Expand Down Expand Up @@ -559,7 +569,9 @@ of an [additional style sheet]:

``` toml
[project]
extra_css = ["stylesheets/extra.css"]
extra_css = [
"stylesheets/extra.css",
]
```

=== "`mkdocs.yml`"
Expand Down
23 changes: 15 additions & 8 deletions docs/authoring/content-tabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ 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 @@ -68,9 +70,13 @@ 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 = {
object = "pymdownx.slugs.slugify",
kwds.case = "lower",
}
}
```

=== "`mkdocs.yml`"
Expand All @@ -95,8 +101,9 @@ following lines to your configuration:

``` toml
[project.theme]
features = ["content.tabs.link"]

features = [
"content.tabs.link",
]
```

=== "`mkdocs.yml`"
Expand Down
7 changes: 4 additions & 3 deletions docs/authoring/data-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ configuration file:
=== "`zensical.toml`"

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

=== "`mkdocs.yml`"
Expand Down Expand Up @@ -148,8 +149,8 @@ via [additional JavaScript]:
``` toml
[project]
extra_javascript = [
"https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js",
"javascripts/tablesort.js"
"https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js",
"javascripts/tablesort.js",
]
```

Expand Down
18 changes: 13 additions & 5 deletions docs/authoring/diagrams.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,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 Expand Up @@ -293,7 +299,9 @@ you can do so by adding a custom JavaScript file to your configuration:

``` toml
[project]
extra_javascript = ["javascripts/mermaid.mjs"]
extra_javascript = [
"javascripts/mermaid.mjs",
]
```

=== "`mkdocs.yml`"
Expand Down
5 changes: 3 additions & 2 deletions docs/authoring/footnotes.md
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 All @@ -44,7 +45,7 @@ enabled with:
``` toml
[project.theme]
features = [
"content.footnote.tooltips"
"content.footnote.tooltips",
]
```

Expand Down
9 changes: 5 additions & 4 deletions docs/authoring/formatting.md
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
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
20 changes: 14 additions & 6 deletions docs/authoring/icons-emojis.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,12 @@ 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 = {
emoji_generator = "zensical.extensions.emoji.to_svg",
emoji_index = "zensical.extensions.emoji.twemoji",
}
```

=== "`mkdocs.yml`"
Expand All @@ -29,8 +33,8 @@ shortcodes. Add the following lines to your configuration:
markdown_extensions:
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_generator: !!python/name:zensical.extensions.emoji.to_svg
emoji_index: !!python/name:zensical.extensions.emoji.twemoji
```

See additional configuration options:
Expand Down Expand Up @@ -110,7 +114,9 @@ While HTML allows inline styles, it's always recommended to add an

``` toml
[project]
extra_css = ["stylesheets/extra.css"]
extra_css = [
"stylesheets/extra.css",
]
```

=== "`mkdocs.yml`"
Expand Down Expand Up @@ -158,7 +164,9 @@ dedicated CSS class to the icon:

``` toml
[project]
extra_css = ["stylesheets/extra.css"]
extra_css = [
"stylesheets/extra.css",
]
```

=== "`mkdocs.yml`"
Expand Down
7 changes: 4 additions & 3 deletions docs/authoring/images.md
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 = {}
Comment thread
pawamoy marked this conversation as resolved.
```

=== "`mkdocs.yml`"
Expand Down
8 changes: 5 additions & 3 deletions docs/authoring/lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ 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
Loading