基础语法

1. 标题

一级标题 (H1)

二级标题 (H2)

三级标题 (H3)

四级标题 (H4)

五级标题 (H5)
六级标题 (H6)
titles.md
# 一级标题 (H1)
 
## 二级标题 (H2)
 
### 三级标题 (H3)
 
#### 四级标题 (H4)
 
##### 五级标题 (H5)
 
###### 六级标题 (H6)

2. 文本样式

这是斜体文本 这也是斜体文本

这是粗体文本 这也是粗体文本

这是粗斜体文本 这也是粗斜体文本

这是带删除线的文本

这是一个 行内代码 的例子。

这是一个块引用。

这是一个嵌套的块引用。

text_styles.md
_这是斜体文本_
_这也是斜体文本_
 
**这是粗体文本**
**这也是粗体文本**
 
**_这是粗斜体文本_**
**_这也是粗斜体文本_**
 
~~这是带删除线的文本~~
 
这是一个 `行内代码` 的例子。
 
> 这是一个块引用。
>
> > 这是一个嵌套的块引用。

3. 列表

无序列表

  • 列表项 A
  • 列表项 B
    • 嵌套列表项 B1
    • 嵌套列表项 B2
  • 列表项 C
unordered_list.md
- 列表项 A
- 列表项 B
  - 嵌套列表项 B1
  - 嵌套列表项 B2
- 列表项 C

有序列表

  1. 第一项
  2. 第二项
    1. 嵌套第一项
    2. 嵌套第二项
  3. 第三项
ordered_list.md
1.  第一项
2.  第二项
    1.  嵌套第一项
    2.  嵌套第二项
3.  第三项

任务列表

这是 GitHub Flavored Markdown 的内容,在这里同样可用。

  • 已完成的任务
  • 未完成的任务
  • 待办事项
task_list.md
- [x] 已完成的任务
- [ ] 未完成的任务
- [ ] 待办事项

4. 代码块

这是一个行内代码块:console.log('Hello, World!');

inline_code.md
这是一个行内代码块:`console.log('Hello, World!');`

代码块的顶端会展示文件名,右上角会展示语言。文件名是可选的,在书写代码块时,在语言右侧空一格加入 title 标记即可。

注意如果不写文件名,那么代码语言也不会显示。

```python title="hello.py"
import antigravity
 
def greet(name):
    """这是一个向世界问好的函数"""
    print(f"Hello, {name}!")
 
if __name__ == "__main__":
    greet("Markdown")
```

效果如下,这是一个带有语法高亮的 Python 代码块:

hello.py
import antigravity
 
def greet(name):
    """这是一个向世界问好的函数"""
    print(f"Hello, {name}!")
 
if __name__ == "__main__":
    greet("Markdown")

这是一个没有指定语言的普通代码块:

plain.txt
npm install
npm run dev

5. 链接与图片

链接

这是一个指向 OpenAI 的链接。

图片

这是一个示例图片
这是一个示例图片

6. 表格

对齐方式左对齐居中对齐右对齐
内容Cell 1Cell 2Cell 3
示例abc
数据123456789

7. 脚注

Shisouhan.md
他人に優しいあんたにこの心がわかるものか
 
人を呪うのが心地良い だから詩を書いていた
 
朝の報道ニュースにいつか載ることが夢だった
 
その為に包丁を研いでる
 
总以温柔待人的你,要怎么明白我的这颗心?
 
诅咒别人让我快乐,所以我才致力于写诗
 
登上早间新闻,向来是我的梦想
 
为此我不停打磨着菜刀
 
——《思想犯》[^1]。
 
[^1]: 《思想犯》是日本摇滚乐团ヨルシカ(YORUSHIKA)创作于 2020 年的歌曲。歌名来自乔治·奥威尔出版于 1949 年的同名小说。

他人に優しいあんたにこの心がわかるものか

人を呪うのが心地良い だから詩を書いていた

朝の報道ニュースにいつか載ることが夢だった

その為に包丁を研いでる

总以温柔待人的你,要怎么明白我的这颗心?

诅咒别人让我快乐,所以我才致力于写诗

登上早间报道的新闻,向来是我的梦想

为此我不停打磨着菜刀

——《思想犯》1

8. 数学公式 (KaTeX)

Haku 支持 LaTeX 语法的数学公式以及化学公式渲染。

行内公式

质能方程是 E=mc2E=mc^2。当 a0a \ne 0 时,二次方程 ax2+bx+c=0ax^2 + bx + c = 0 的解为 x=b±b24ac2ax = {-b \pm \sqrt{b^2-4ac} \over 2a}

Mass_Energy_Equivalent_Formula_(Einstein).tex
质能方程是 $ E=mc^2 $。当 $ a \ne 0 $ 时,二次方程 $ ax^2 + bx + c = 0 $ 的解为 $ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $

块级公式

麦克斯韦方程组 (积分形式):

SDda=QinSBda=0CEdl=dΦBdtCHdl=Iin+dΦDdt \oint_S \mathbf{D} \cdot d\mathbf{a} = Q_{in} \\ \oint_S \mathbf{B} \cdot d\mathbf{a} = 0 \\ \oint_C \mathbf{E} \cdot d\mathbf{l} = - \frac{d\Phi_B}{dt} \\ \oint_C \mathbf{H} \cdot d\mathbf{l} = I_{in} + \frac{d\Phi_D}{dt}
Maxwell.tex
$$
 
\oint_S \mathbf{D} \cdot d\mathbf{a} = Q_{in} \\
\oint_S \mathbf{B} \cdot d\mathbf{a} = 0 \\
\oint_C \mathbf{E} \cdot d\mathbf{l} = - \frac{d\Phi_B}{dt} \\
\oint_C \mathbf{H} \cdot d\mathbf{l} = I_{in} + \frac{d\Phi_D}{dt}
 
$$

9. Mermaid 图表渲染

Haku 支持多种 mermaid 图表。

流程图

这是一个极为复杂的流程图。

services.md
```mermaid
graph TB
    subgraph ClientLayer [客户端层]
        direction TB
        Web[Web 浏览器] --> |HTTPS/443| LB[负载均衡器]
        App[移动端 App] --> |API/443| LB
    end
 
    subgraph ClusterLayer [K8s 集群]
        LB --> Ingress[Ingress Gateway]
 
        subgraph Services [核心服务网格]
            direction LR
            Auth[认证服务]
            User[用户中心]
            Order[订单系统]
            Pay[支付网关]
 
            Ingress --> Auth
            Auth --> User
            Ingress --> Order
            Order --> Pay
            Order --> User
            Pay --> Wechat[微信支付]
            Pay --> AliPay[支付宝]
        end
 
        subgraph DataLayer [数据持久层]
            Redis[(Redis 缓存)]
            MySQL[(MySQL 主从)]
            ES{ElasticSearch}
 
            User --> MySQL
            Order --> MySQL
            Order --> Redis
            Services --> ES
        end
 
        subgraph MessageQueue [消息中间件]
            Kafka{{Apache Kafka}}
            Pay -.-> |支付成功事件| Kafka
            Kafka -.-> |消费| Order
            Kafka -.-> |消费| User
        end
    end
 
    style ClientLayer fill:#f9f,stroke:#333
    style Services fill:#e1f5fe,stroke:#0277bd
    style DataLayer fill:#fff3e0,stroke:#ff6f00
```

K8s 集群

客户端层

消息中间件

数据持久层

核心服务网格

HTTPS/443

API/443

支付成功事件

消费

消费

Web 浏览器

负载均衡器

移动端 App

Ingress Gateway

认证服务

用户中心

订单系统

支付网关

微信支付

支付宝

Redis 缓存

MySQL 主从

ElasticSearch

Apache Kafka

序列图

greetings.md
```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!
```
JohnBobAliceJohnBobAliceloop[Healthcheck]Rational thoughts prevail!Hello John, how are you?Fight against hypochondriaGreat!How about you?Jolly good!

饼图

code_langs.md
```mermaid
pie
    title 编程语言分布
    "JavaScript" : 45
    "Python" : 25
    "Java" : 15
    "C++" : 10
    "Other" : 5
```
45%25%15%10%5%编程语言分布JavaScriptPythonJavaC++Other

甘特图

saas_route.md
```mermaid
gantt
    title 2024年 SaaS 平台研发路线图
    dateFormat  YYYY-MM-DD
    axisFormat  %m-%d
    excludes weekends
 
    section 需求阶段
    市场调研       :done,    des1, 2024-01-01, 2024-01-10
    需求评审       :active,  des2, 2024-01-11, 5d
    UI/UX 原型设计 :         des3, after des2, 7d
 
    section 核心开发 (后端)
    数据库架构设计 :crit,    back1, after des3, 5d
    用户认证模块   :         back2, after back1, 7d
    支付接口对接   :         back3, after back2, 10d
    API 压力测试   :         back4, 2024-02-15, 5d
 
    section 前端开发 (Web & Mobile)
    环境搭建       :         front1, after des3, 3d
    组件库开发     :         front2, after front1, 10d
    管理后台开发   :         front3, after back2, 12d
    落地页开发     :         front4, after front3, 5d
 
    section 部署与运维
    CI/CD 流程配置 :active,  ops1, 2024-01-20, 7d
    Docker 容器化  :         ops2, after ops1, 5d
    灰度发布       :milestone, 2024-03-01, 0d
    正式上线       :crit, 2024-03-10, 0d
```
01-07 01-14 01-21 01-28 02-04 02-11 02-18 02-25 03-03 03-10市场调研 需求评审 UI/UX 原型设计 CI/CD 流程配置 数据库架构设计 环境搭建 Docker 容器化 组件库开发 用户认证模块 支付接口对接 管理后台开发 API 压力测试 落地页开发 灰度发布 正式上线 需求阶段核心开发 (后端)前端开发 (Web & Mobile)部署与运维2024年 SaaS 平台研发路线图

10. 提示/警告块

这种语法在 GitHub、Docsify 和许多文档生成器中很流行。

notifications.md
> [!NOTE]
> 这是一个提示(Note)。用于引起注意的普通信息。
 
> [!TIP]
> 这是一个技巧(Tip)。用于提供有用的建议或快捷方式。
 
> [!IMPORTANT]
> 这是重要信息(Important)。需要用户特别关注的内容。
 
> [!WARNING]
> 这是一个警告(Warning)。用于提示潜在的风险或需要谨慎操作的地方。
 
> [!CAUTION]
> 这是一个危险警告(Caution)。表示执行此操作可能会导致严重后果。
 
:::note[自定义标题]
这是一个自定义标题的提示块。
:::
NOTE

这是一个提示(Note)。用于引起注意的普通信息。

TIP

这是一个技巧(Tip)。用于提供有用的建议或快捷方式。

IMPORTANT

这是重要信息(Important)。需要用户特别关注的内容。

WARNING

这是一个警告(Warning)。用于提示潜在的风险或需要谨慎操作的地方。

CAUTION

这是一个危险警告(Caution)。表示执行此操作可能会导致严重后果。

自定义标题

这是一个自定义标题的提示块。


11. HTML 标签

可以直接书写大多数 HTML 标签。

styles.html
这段文字应该是 <span style="color: #007bff;">蓝色</span> 的,而这段是
<span style="color: #dc3545;">红色</span> 的。
 
H<sub>2</sub>O
 
X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
 
<abbr title="Graphics Interchange Format">GIF</abbr> 是一种位图图像格式。
 
书籍是人类进步的<del>楼梯</del>阶梯。
 
优秀的作家总是会仔细检查<u title="拼写">拚写</u>问题。
 
按下 <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Delete</kbd> 以结束会话。
 
大多数<mark>蝾螈</mark>昼伏夜出,以昆虫、蠕虫等小生物为食。
 
使用三个连字符 `---` 或 `<hr>` 标签,即可创建如下分隔线。
 
---

使用 HTML 标签来改变文本颜色:这段文字应该是 蓝色 的,而这段是 红色 的。

H2O

Xn + Yn = Zn

GIF 是一种位图图像格式。

书籍是人类进步的楼梯阶梯。

优秀的作家总是会仔细检查拚写问题。

按下 Ctrl + Alt + Delete 以结束会话。

大多数蝾螈昼伏夜出,以昆虫、蠕虫等小生物为食。

使用三个连字符 ---<hr> 标签,即可创建如下分隔线。


12. 折叠块

:::fold[-]创建折叠块。

点击展开查看详细信息

这里是隐藏的详细内容。可以包含段落、列表、甚至是图片。

collapsible.md
:::fold[点击展开查看详细信息]
这里是隐藏的详细内容。可以包含段落、列表、甚至是图片。
:::

Footnotes

  1. 《思想犯》是日本摇滚乐团ヨルシカ(YORUSHIKA)创作于 2020 年的歌曲。歌名来自乔治·奥威尔出版于 1949 年的同名小说。

返回文章页面

分享

评论区