Skip to content

refactor: format Markdown with Zensical Studio #153

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

Merged
squidfunk merged 1 commit into from
Jul 30, 2026
Merged

refactor: format Markdown with Zensical Studio #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
indent_size = 4
4 changes: 4 additions & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
"docs/**/*.md": "python-markdown",
},
"git.ignoreLimitWarning": true,
"[python-markdown]": {
"editor.defaultFormatter": "zensical.zensical-studio",
"editor.formatOnSave": true
},
"search.followSymlinks": false,
"typescript.tsdk": "node_modules/typescript/lib",
"yaml.schemas": {
Expand Down
23 changes: 9 additions & 14 deletions docs/authoring/admonitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,6 @@ See additional configuration options:
- [Details]
- [SuperFences]

[Admonition]: ../setup/extensions/python-markdown.md#admonition
[Details]: ../setup/extensions/python-markdown-extensions.md#details
[SuperFences]: ../setup/extensions/python-markdown-extensions.md#superfences

### Admonition icons

Each of the supported admonition types has a distinct icon, which can be changed
Expand Down Expand Up @@ -76,7 +72,6 @@ lines to your configuration:
quote = "octicons/quote-16"
```


=== ":fontawesome-brands-font-awesome: FontAwesome"

``` toml
Expand Down Expand Up @@ -126,7 +121,6 @@ lines to your configuration:
quote: octicons/quote-16
```


=== ":fontawesome-brands-font-awesome: FontAwesome"

``` yaml
Expand All @@ -147,8 +141,6 @@ lines to your configuration:
quote: fontawesome/solid/quote-left
```

[custom icon]: ../setup/logo-and-icons.md#additional-icons

## Usage

Admonitions follow a simple syntax: a block starts with `!!!`, followed by a
Expand All @@ -173,8 +165,6 @@ the next line, indented by four spaces:

</div>

[type qualifier]: #supported-types

### Change the title

By default, the title will equal the type qualifier in titlecase. However, it
Expand Down Expand Up @@ -231,6 +221,7 @@ can use your existing admonitions and indent the desired ones:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

</div>

### Remove the title
Expand All @@ -257,9 +248,6 @@ not work for [collapsible blocks]:

</div>

[changing the title]: #change-the-title
[collapsible blocks]: #collapsible-blocks

### Collapsible blocks

When [Details] is enabled and an admonition block is started with `???` instead
Expand Down Expand Up @@ -350,7 +338,7 @@ only the `inline` modifier:

Use `inline` to align to the left (right for rtl languages).

__Important__: admonitions that use the `inline` modifiers _must_ be declared
**Important**: admonitions that use the `inline` modifiers _must_ be declared
prior to the content block you want to place them beside. If there's
insufficient space to render the admonition next to the block, the admonition
will stretch to the full width of the viewport, e.g., on mobile viewports.
Expand Down Expand Up @@ -443,3 +431,10 @@ The following admonition types are available in Zensical. The default is `note`.
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa.

[Admonition]: ../setup/extensions/python-markdown.md#admonition
[changing the title]: #change-the-title
[collapsible blocks]: #collapsible-blocks
[custom icon]: ../setup/logo-and-icons.md#additional-icons
[Details]: ../setup/extensions/python-markdown-extensions.md#details
[SuperFences]: ../setup/extensions/python-markdown-extensions.md#superfences
[type qualifier]: #supported-types
18 changes: 7 additions & 11 deletions docs/authoring/buttons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ See additional configuration options:

- [Attribute Lists]

[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists

## Usage

### Add a button
Expand All @@ -53,10 +51,6 @@ In order to render a link as a button, suffix it with curly braces and add the

</div>

[primary color]: ../setup/colors.md#primary-color
[accent color]: ../setup/colors.md#accent-color
[Demo]: javascript:alert$.next("Demo")

### Add a primary button

If you want to display a filled, primary button (like on the [landing page]
Expand All @@ -73,16 +67,11 @@ CSS class selectors.

</div>

[landing page]: https://zensical.org

### Add a button with an icon

Of course, icons can be added to all types of buttons by using the [icon syntax]
together with any valid [icon shortcode]:

[icon shortcode]: icons-emojis.md#included-icon-sets
[icon syntax]: icons-emojis.md#use-icons

``` markdown title="Button with icon"
[Send :fontawesome-solid-paper-plane:](#){ .md-button }
```
Expand All @@ -93,3 +82,10 @@ together with any valid [icon shortcode]:

</div>

[accent color]: ../setup/colors.md#accent-color
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
[Demo]: javascript:alert$.next("Demo")
[icon shortcode]: icons-emojis.md#included-icon-sets
[icon syntax]: icons-emojis.md#use-icons
[landing page]: https://zensical.org
[primary color]: ../setup/colors.md#primary-color
Loading