style: improve documentation formatting for layouts

This commit is contained in:
Cell
2026-03-20 11:44:15 +08:00
parent 9e384b666f
commit 65ad407cd0
4 changed files with 48 additions and 49 deletions
+1 -1
View File
@@ -1,4 +1,4 @@
{{- hugo.Store.Set "version" "v0.4.5-20260319071939-1db7fbde" -}}
{{- hugo.Store.Set "version" "v0.4.5-20260320034416-9e384b66" -}}
{{- .Store.Set "this" dict -}}
{{- partial "init/detection-env.html" . -}}
+7 -7
View File
@@ -1,12 +1,12 @@
{{- /*
* The extended syntax of alert is compatible with Obsidian and FixIt admonition shortcode.
* @param {String} .Text the content of the admonition box
* @param {String} [.Type] the type of the admonition box
* @param {String} [.Title] the title of the admonition box
* @param {Boolean} [.Open] whether the admonition box is open, default is true
* @param {Boolean} [.Foldable] whether the admonition box is foldable, default is true
* For custom admonitions, see https://fixit.lruihao.cn/documentation/content-management/shortcodes/extended/admonition/#customize-admonitions
The extended syntax of alert is compatible with Obsidian and FixIt admonition shortcode.
@param {String} .Text the content of the admonition box
@param {String} [.Type] the type of the admonition box
@param {String} [.Title] the title of the admonition box
@param {Boolean} [.Open] whether the admonition box is open, default is true
@param {Boolean} [.Foldable] whether the admonition box is foldable, default is true
For custom admonitions, see https://fixit.lruihao.cn/documentation/content-management/shortcodes/extended/admonition/#customize-admonitions
*/ -}}
{{- $iconMap := dict
+5 -5
View File
@@ -1,9 +1,9 @@
{{- /*
* The basic syntax of alert is compatible with GitHub, Obsidian, and Typora.
* @param {String} .Type the type of the alert box
* @param {String} .Text the content of the alert box
* @param {Map} [.Attributes] the attributes of the alert box
* @example {{- dict "Text" .Text "Type" .AlertType "Attributes" .Attributes | partial "plugin/alert.html" -}}
The basic syntax of alert is compatible with GitHub, Obsidian, and Typora.
@param {String} .Type the type of the alert box
@param {String} .Text the content of the alert box
@param {Map} [.Attributes] the attributes of the alert box
@example {{- dict "Text" .Text "Type" .AlertType "Attributes" .Attributes | partial "plugin/alert.html" -}}
*/ -}}
{{- $iconMap := dict
+35 -36
View File
@@ -1,54 +1,53 @@
{{- /*
Renders an HTML details element.
Renders an HTML details element.
@param {string} [class] The value of the element's class attribute.
@param {string} [name] The value of the element's name attribute.
@param {string} [summary] The content of the child summary element.
@param {string} [title] The value of the element's title attribute.
@param {bool} [open=false] Whether to initially display the content of the details element.
@param {string} [class] The value of the element's class attribute.
@param {string} [name] The value of the element's name attribute.
@param {string} [summary] The content of the child summary element.
@param {string} [title] The value of the element's title attribute.
@param {bool} [open=false] Whether to initially display the content of the details element.
@reference https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details
@reference https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details
@examples
@examples
{{< details >}}
A basic collapsible section.
{{< /details >}}
{{< details >}}
A basic collapsible section.
{{< /details >}}
{{< details summary="Custom Summary Text" >}}
Showing custom `summary` text.
{{< /details >}}
{{< details summary="Custom Summary Text" >}}
Showing custom `summary` text.
{{< /details >}}
{{< details summary="Open Details" open=true >}}
Contents displayed initially by using `open`.
{{< /details >}}
{{< details summary="Open Details" open=true >}}
Contents displayed initially by using `open`.
{{< /details >}}
{{< details summary="Styled Content" class="my-custom-class" >}}
Content can be styled with CSS by specifying a `class`.
{{< details summary="Styled Content" class="my-custom-class" >}}
Content can be styled with CSS by specifying a `class`.
Target details element:
Target details element:
```css
details.my-custom-class { }
```
```css
details.my-custom-class { }
```
Target summary element:
Target summary element:
```css
details.my-custom-class > summary > * { }
```
```css
details.my-custom-class > summary > * { }
```
Target inner content:
Target inner content:
```css
details.my-custom-class > :not(summary) { }
```
{{< /details >}}
{{< details summary="Grouped Details" name="my-details" >}}
Specifying a `name` allows elements to be connected, with only one able to be open at a time.
{{< /details >}}
```css
details.my-custom-class > :not(summary) { }
```
{{< /details >}}
{{< details summary="Grouped Details" name="my-details" >}}
Specifying a `name` allows elements to be connected, with only one able to be open at a time.
{{< /details >}}
*/}}
{{- /* Get arguments. */}}