发布于 2023-2-12

扩展语法支持

Hugo Stellar 扩展语法补丁。

MkDocs 语法 #

Hint #

Example
1
2
!!! note
    `markdown` text

note

markdown text

Example
1
2
!!! note Custom Title
    `markdown` text

Custom Title

markdown text

Example
1
2
??? note Collapsible
    `markdown` text
Collapsible

markdown text

Example
1
2
???+ note Collapsible Open
    `markdown` text
Collapsible Open

markdown text

Hint 允许包含和嵌套任意内容。

Example
1
2
3
4
???+ bug
    ???+ bug
        ???+ bug
            Nested bugs.
bug
bug
bug

Nested bugs.

MkDocs 一共支持 12 种 Hint。

note

markdown text

abstract

markdown text

info

markdown text

tip

markdown text

success

markdown text

question

markdown text

warning

markdown text

failure

markdown text

danger

markdown text

bug

markdown text

example

markdown text

quote

markdown text

Columns #

Columns 用于并排显示某些内容(在较窄的屏幕上会自动取消 Columns 效果)。

通过 HTML 注释 <!-- --> 将不同的 Columns 隔开。

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
:::
    !!! note Top Left
        `markdown` text
:::
    !!! note Top Right
        `markdown` text

<!--  -->

:::
    !!! note Bottom Left
        `markdown` text
:::
    !!! note Bottom Right
        `markdown` text

Top Left

markdown text

Top Right

markdown text

Bottom Left

markdown text

Bottom Right

markdown text

Tabs #

Tabs 用于呈现选项卡效果,允许包含和嵌套任意内容。

当 Tab 没有内容时,对应的选项卡将不可点击。

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
=== Disabled

=== Tab 1
    !!! tip
        This is Tab 1.

=== Tab 2
    !!! warning
        This is Tab 2.

=== Tab 3
    !!! danger
        This is Tab 3.

tip

This is Tab 1.

warning

This is Tab 2.

danger

This is Tab 3.

Stellar 语法 #

Inline #

Note #

Example
1
2
3
4
{% note Title `Markdown` text %}
{% note color:red Title `Markdown` text %}
<!-- 使用 "&nbsp;" 在标题中呈现空格 -->
{% note color:blue Hello&nbsp;World `Markdown` text %}

Title

Markdown text

Title

Markdown text

Hello World

Markdown text

Note 一共支持 12 种颜色。

Default

Markdown text

red

Markdown text

orange

Markdown text

yellow

Markdown text

green

Markdown text

cyan

Markdown text

blue

Markdown text

purple

Markdown text

light

Markdown text

dark

Markdown text

warning

Markdown text

error

Markdown text

Mark #

Mark 和 Note 一样支持 12 种颜色。

Example
1
2
3
{% mark Default %}
{% mark color:blue Blue %}
{% mark color:green Green %}
Default Blue Green

Tag #

Example
1
2
3
{% tag GitHub https://github.com/ %}
{% tag color:blue Hexo https://hexo.io/ %}
{% tag color:green W3Schools https://www.w3schools.com/ %}

Copy #

Example
1
2
{% copy sudo apt-get upgrade %}
{% copy sudo ubuntu-drivers autoinstall %}
sudo apt-get upgrade
sudo ubuntu-drivers autoinstall

Radio #

Example
1
2
{% radio `markdown` text %}
{% radio checked:true `markdown` text %}
markdown text
markdown text

Checkbox #

Example
1
2
3
4
5
{% checkbox `markdown` text %}
{% checkbox checked:true `markdown` text %}
{% checkbox symbol:plus color:green checked:true `markdown` text %}
{% checkbox symbol:minus color:yellow checked:true `markdown` text %}
{% checkbox symbol:times color:red checked:true `markdown` text %}
markdown text
markdown text
markdown text
markdown text
markdown text

Display #

Folding #

Example
1
2
3
{% folding Title open:true color:blue %}
`Markdown` text
{% endfolding %}
Title
Markdown text

Folding 允许包含和嵌套任意内容

Example
1
2
3
4
5
6
7
{% folding Warning color:yellow %}
{% folding Dangerous color:orange %}
{% folding Prohibited color:red %}
`Markdown` text
{% endfolding %}
{% endfolding %}
{% endfolding %}
Warning
Dangerous
Prohibited
Markdown text

Poetry #

Example
1
2
3
4
5
6
{% poetry 独不见 author:唐·沈佺期 footer:诗词节选 %}
卢家少妇郁金堂,海燕双栖玳瑁梁。
**九月寒砧催木叶,十年征戍忆辽阳。**
白狼河北音书断,丹凤城南秋夜长。
谁为含愁独不见,更教明月照流黄?
{% endpoetry %}
独不见
唐·沈佺期

卢家少妇郁金堂,海燕双栖玳瑁梁。

九月寒砧催木叶,十年征戍忆辽阳。

白狼河北音书断,丹凤城南秋夜长。

谁为含愁独不见,更教明月照流黄?