← 所有文章

从一份 Markdown 开始

Markdown 写作的几个基本约定:文件放在哪里、文章地址怎么定,以及发布前检查什么。

这是一篇样稿,用于展示排版与功能。不是作者的正式文章。

打开一个空白文件,写下标题。光标还在闪,正文倒不必急着漂亮。

这篇样稿介绍这个博客的写作方式,也顺便放几种常见排版:小标题、引用、代码和表格。正式写文章时,把文件换成自己的内容即可。

先把文章放好

文章保存在 src/content/posts/。每篇文章是一个 .md 或 .mdx 文件,开头的几行记录标题、时间和标签,后面就是正文。

---
title: 文章的标题
description: 用一两句话说明这篇文章讲什么。
slug: my-first-post
pubDate: 2026-11-06
tags: [随记]
draft: false
comments: true
---

slug 决定文章地址。这里填写 my-first-post,发布后的路径就是 /posts/my-first-post/。它可以短一点,也最好早一点想清楚。

正文只管写

Markdown 的好处是,写的时候不用盯着工具栏。一个空行分开两段文字,两个井号开始一个小节。需要引用时,行首加一个大于号。

一段文字值得留下,往往因为它说清楚了一件具体的事。

列表适合几件并列的事情。事情只有一件,就写成一句话。

  • 想法还不完整,可以先存成草稿。
  • 引用了别人的文字,记下出处。
  • 修改文章标题时,保留原来的地址。

图片和代码

图片可以和文章一起放进仓库;需要展示代码时,用围栏代码块,并注明语言。代码块会自动着色,长行可以单独横向滚动。

const article = {
  title: '把这一篇写完',
  draft: true,
};

console.log(article.title);

写完以后,先看一遍

启动本地预览,检查标题有没有断得奇怪、代码有没有太长、引用有没有来源。手机上的一屏能装多少文字,也值得看一眼。

检查什么 看哪里
标题与摘要 首页和文章开头
段落与代码 正文的真实阅读宽度
标签与日期 文章页和归档
地址 发布后尽量保持不变

确认后提交 Git,构建会生成页面和搜索索引。草稿不会出现在正式页面、搜索、RSS 或站点地图中。

工具准备到这里就够了。下一次打开文件,接着写正文。

聊聊这篇文章

欢迎留下你的想法。

可以快捷登录,也可以直接填写昵称留言。评论审核后公开;邮箱选填,不会公开展示。

滚动到这里时加载评论。