← 返回文章归档

用 Markdown 写一篇清楚的文章

从标题结构到代码与公式,整理一份可以边写边用的小指南。

先写清楚想回答的问题

在开始之前,先用一句话说明这篇文章要解决什么问题。这句话通常也可以成为文章的摘要。

正文使用二级和三级标题划分章节,右侧目录会根据实际生成的标题自动建立。

把示例放在解释旁边

代码最好能独立说明一个小概念,例如把分钟转换为秒:

function toSeconds(minutes: number): number {
  return minutes * 60;
}

console.log(toSeconds(3)); // 180

与其一次贴出整个项目,不如先展示关键部分,再解释它与其他代码的关系。

公式也可以是解释的一部分

从 11 加到 nn 的求和公式:

∑i=1ni=n(n+1)2\sum_{i=1}^{n} i = \frac{n(n+1)}{2}

一张简单的表格

内容建议
标题让读者知道文章讨论什么
摘要用一两句话交代问题
示例选择小而完整的例子
结尾说明适用条件和下一步

发布之前再读一遍

检查链接、代码和排版。把没解释的缩写补充完整,把重复的句子删掉。写得清楚,比写得复杂更有用。

给文章加密码

在写作后台编辑文章时,填写「文章密码」再发布。读者打开文章后需要输入密码,才能看到正文。已有密码的文章留空保存会保持原密码;勾选「取消密码保护」并保存,就会恢复公开阅读。

如果直接在 src/content/posts 目录写 Markdown 文件,可以在文章最上方的 frontmatter 加一行 password:

---
title: 一篇需要密码的文章
description: 这是一篇受保护文章的摘要
date: 2026-09-29
tags: [写作]
password: "请换成你自己的密码"
---

这里开始写正文。

标题、摘要和标签仍会公开显示;不要把私密内容写在这些字段里。直接写在 Markdown 文件中的密码会以明文保存在项目源码中,因此不要把真实密码提交到公开仓库。密码保护用于控制网页阅读,不等同于对源码文件加密。

✳

感谢阅读,下一篇再见。

回到文章开头 ↑