← Writing
Markdown Test
本文介绍 Commonplace 的 Markdown 写作格式;HTML 写作格式请参考《写作指南》。每个章节先展示渲染效果,再提供对应写法。文章标题、日期和阅读时长由系统自动生成。
标题
文内只用两级:## 作章节、### 作小节。文章题目本身已是 h1,正文里不要再出现。你现在看到的每个小标题就是 ##,下面这行是 ###:
这是一个小节标题
markdownMarkdown
## 章节标题
### 小节标题段落与行内格式
正文每段单独成段,段落之间留空,首行不缩进。支持以下行内格式:加粗、斜体、删除线、行内代码 和 示例链接。
markdownMarkdown
**加粗**、*斜体*、~~删除线~~、`行内代码` 与 [示例链接](https://example.com)。列表
无序列表放彼此独立的并列信息,有序列表放有先后顺序的步骤;每条一到两行,尽量不嵌套:
- 无序列表:并列、彼此独立的信息;
- 每条保持一行,标点与正文一致。
- 有序列表:有先后顺序的步骤;
- 后一步依赖前一步时,用它。
markdownMarkdown
- 并列项;
- 并列项。
1. 第一步;
2. 第二步。代码块
代码用三反引号围栏:第一行先写语言名,空一格再写文件名(可省略),分别对应代码块顶栏右侧的语言标签和左侧的文件名。块内关键字自动显示为主题色、注释显示为灰色,不需要手工标记。下面这块本身就是一个代码块:
main.rsRust
let s = String::from("hi"); // 关键字有色,注释是灰的markdownMarkdown
```rust main.rs
let s = String::from("hi");
```引用
引用有两种用法:摘录别人的话(附来源),或单独突出一条自己的笔记。样式同为左侧一道主题色竖线;引用内用空行分段,末段以「——」开头会自动显示为来源小字:
摘录的样子:别人的一句话,末行附上出处。
—— 示例来源
个人笔记的样子:只有一句话,不加来源。
markdownMarkdown
> 引用正文。
>
> —— 来源(可选)表格
少量对照信息用表格:表头小字灰色,行间只留横线:
| 格式 | 用途 |
|---|---|
## / ### |
章节与小节 |
| 围栏代码块 | 代码块 |
| 引用 | 引用与笔记 |
markdownMarkdown
| 表头 | 表头 |
| --- | --- |
| 单元格 | 单元格 |图片
图片用 :带图注时渲染为带圆角的 figure 并居中显示图注,省略图注则只插图:
markdownMarkdown
")分隔线
章节之间需要硬切换时用一条 ---,一次一条,不要连用:
markdownMarkdown
---