LinhoNotes

外观

基本扩展 ​

基本扩展指的是在相当多平台受认可的 Markdown 扩展语法。

GFM 风格提示框 ​

支持使用 GFM 提示框标记特别的段落。

markdown
> [!tip]
>
> 应引起关注的文本。

> [!note]
>
> 应引起关注的文本。

> [!important]
>
> 应引起关注的文本。

> [!warning]
>
> 应引起关注的文本。

> [!caution]
>
> 应引起关注的文本。
渲染结果

TIP

应引起关注的文本。

NOTE

应引起关注的文本。

IMPORTANT

应引起关注的文本。

WARNING

应引起关注的文本。

CAUTION

应引起关注的文本。

不要在提示框中添加标题。本仓库提供一个优化：如果 GFM 提示框中的第一行全加粗，将用这一行替代提示框的标题。

markdown
> [!warning]
>
> **自定义的标题可以覆盖提示框**
>
> 这是提示框的内容，可以有很多行。
渲染结果

自定义的标题可以覆盖提示框

这是提示框的内容，可以有很多行。

公式 ​

使用 LATEX 书写公式。

  • 使用 $ 标记行内公式，使用 $$ 标记行间公式。
  • $ 的前后不能都是空格，否则会导致渲染失败。
  • LaTeX 标准不统一，因此不作过多要求，但应保持基本的兼容性，如在 VSCode 中应能正常渲染。
markdown
When $a \ne 0$, there are two solutions to $(ax^2 + bx + c = 0)$ and they are

$$
x = {-b \pm \sqrt{b^2-4ac} \over 2a}
$$
渲染结果

When a≠0, there are two solutions to (ax2+bx+c=0) and they are

x=−b±b2−4ac2a

WARNING

公式渲染出错会导致构建报错。GitHub Actions 将会向产生错误的 commit 的作者发送邮件。

脚注 ​

支持使用 [^1] 标记脚注。

markdown
需要标记的文字[^1]。

...

[^1]: 脚注内容。
渲染结果

需要标记的文字。

...

Mermaid 示意图 ​

使用 mermaid 代码框标记 Mermaid 示意图。当前使用 Mermaid v11.3。

markdown
```mermaid
sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop HealthCheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
```
渲染结果

WARNING

由于 Mermaid 依赖浏览器的布局 API，因此无法进行 SSR（服务器端渲染），只能在前端渲染。因此如果 Mermaid 代码中存在错误，无法在构建时发现。

请在确保 Mermaid 图可以正确渲染后再插入。