欢迎使用 Hexo!这是您的第一篇文章。如需更多信息,请查阅 文档。如果在使用 Hexo 时遇到任何问题,可以在 故障排除 中找到答案,也可以在 GitHub 上向我提问。
快速开始
创建新文章
1 | $ hexo new "我的新文章" |
更多信息:写作
启动服务器
1 | $ hexo server |
更多信息:服务器
生成静态文件
1 | $ hexo generate |
更多信息:生成
部署到远程站点
1 | $ hexo deploy |
更多信息:部署
Markdown 常用格式完整示例
1. 标题
二级标题
三级标题
四级标题
五级标题
六级标题
2. 段落与换行
这是一个普通段落。Markdown 段落之间需要空一行。
这是第二个段落。
这一行使用两个空格实现软换行。
3. 强调
粗体文本
斜体文本
粗斜体文本
删除线文本
高亮文本
注意:
==高亮==不是所有 Markdown 渲染器都支持。更通用写法如下:
HTML 高亮文本
4. 列表
4.1 无序列表
- 第一项
- 第二项
- 第三项
- 子项目 A
- 子项目 B
4.2 有序列表
- 第一步
- 第二步
- 第三步
- 子步骤 1
- 子步骤 2
4.3 任务列表
- 已完成任务
- 未完成任务
- 待确认任务
5. 引用
这是一级引用。
这是嵌套引用。
6. 链接与图片
6.1 普通链接
6.2 带标题的链接
6.3 自动链接
6.4 图片
7. 行内代码与代码块
7.1 行内代码
使用 console.log("Hello Markdown") 输出文本。
7.2 Code Block
1 | function greet(name) { |
1 | def add(a: int, b: int) -> int: |
7.3 Code Block Diff
1 | diff --git a/example.js b/example.js |
8. 表格
| 名称 | 类型 | 说明 |
|---|---|---|
| Markdown | 标记语言 | 轻量级文本格式 |
| Mermaid | 图表语法 | 用文本生成图表 |
| GitHub Alert | 扩展语法 | GitHub 风格提示框 |
9. 数学公式
9.1 Inline Math
质能方程是 。
9.2 Math Block
10. 下标与上标
10.1 HTML 写法
水的化学式是 H2O。
平方公式是 x2 + y2 = z2。
10.2 数学公式写法
水的化学式:
平方公式:
11. 分割线
12. GitHub 风格警报框
Note
这是普通说明信息。
Tip
这是实用建议。
Important
这是重要信息。
Warning
这是警告信息。
Caution
这是高风险提醒。
13. Mermaid 图表
需要 Markdown 渲染器支持 Mermaid,例如 GitHub、Obsidian、Typora、VS Code 插件等。
13.1 流程图 Flowchart
flowchart TD
A[开始] --> B{是否满足条件}
B -- 是 --> C[执行方案 A]
B -- 否 --> D[执行方案 B]
C --> E[结束]
D --> Eflowchart TD
A[开始] --> B{是否满足条件}
B -- 是 --> C[执行方案 A]
B -- 否 --> D[执行方案 B]
C --> E[结束]
D --> E13.2 序列图 Sequence Diagram
sequenceDiagram
participant User as 用户
participant App as 应用
participant API as API 服务
participant DB as 数据库
User->>App: 发起请求
App->>API: 调用接口
API->>DB: 查询数据
DB-->>API: 返回结果
API-->>App: 返回响应
App-->>User: 展示结果sequenceDiagram
participant User as 用户
participant App as 应用
participant API as API 服务
participant DB as 数据库
User->>App: 发起请求
App->>API: 调用接口
API->>DB: 查询数据
DB-->>API: 返回结果
API-->>App: 返回响应
App-->>User: 展示结果13.3 类图 Class Diagram
classDiagram
class User {
+String name
+String email
+login()
+logout()
}
class Admin {
+manageUsers()
}
User <|-- AdminclassDiagram
class User {
+String name
+String email
+login()
+logout()
}
class Admin {
+manageUsers()
}
User <|-- Admin13.4 状态图 State Diagram
stateDiagram-v2
[*] --> Idle
Idle --> Loading: 提交请求
Loading --> Success: 请求成功
Loading --> Error: 请求失败
Success --> [*]
Error --> Idle: 重试stateDiagram-v2
[*] --> Idle
Idle --> Loading: 提交请求
Loading --> Success: 请求成功
Loading --> Error: 请求失败
Success --> [*]
Error --> Idle: 重试14. 转义字符
如果需要显示 Markdown 特殊字符,可以使用反斜杠转义。
# 这不是标题
- 这不是列表
* 这不是斜体 *
15. 脚注
这是一个带脚注的句子。^1
16. 定义列表
- 术语一
- 这是术语一的定义。
- 术语二
- 这是术语二的定义。
17. 折叠内容
点击展开
这里是被折叠的内容。
- 支持列表
- 支持代码
- 支持公式:
18. 综合示例
Important
以下示例混合使用了标题、列表、链接、公式、代码和 Mermaid。
项目初始化流程
- 阅读 Markdown Guide
- 安装依赖
- 编写代码
- 提交 Pull Request
1 | npm install |
复杂度估算:。
flowchart LR
A[编写文档] --> B[本地预览]
B --> C{是否通过}
C -- 是 --> D[提交]
C -- 否 --> Aflowchart LR
A[编写文档] --> B[本地预览]
B --> C{是否通过}
C -- 是 --> D[提交]
C -- 否 --> A