示例:用 Markdown 写作的排版细节
目录
这是示例文章,重点展示富文本元素在页面上的样子。
行内代码与强调
安装依赖时用 npm install,构建时用 npm run build。加粗和斜体在中文里要克制使用,太多会让页面显得吵。
代码块
代码块会横向滚动,不会撑宽页面:
export function readingTimeMinutes(text: string): number {
const cjkCount = (text.match(/[一-鿿]/g) ?? []).length;
const minutes = cjkCount / 300;
return Math.max(1, Math.ceil(minutes));
}Shell 命令同理:
npm run validate
npm run build表格
| 元素 | 建议 | 备注 |
|---|---|---|
| 段落 | 一段一个意思 | 避免连续长段 |
| 列表 | 三到七项 | 超过就拆分 |
| 引用 | 一句为佳 | 长引用容易跳读 |
表格在窄屏下会在自己的容器里横向滚动。
列表
- 先写标题,确定这一节只讲一件事
- 再写第一段,直接给结论
- 最后补细节,按重要性排列
无序列表也一样:
- 标题层级不要跳级
- 一篇文章只有一个一级标题
- 小节标题尽量短
排版的目的不是好看,是让读者不用费力就能读完。