Frontmatter 字段

每篇文章开头的 YAML frontmatter 是文章的元数据。以下是必填字段:

字段说明
title文章标题
slugURL 路径,唯一
excerpt摘要,用于列表和 SEO
published_at发布时间(ISO 8601)
author作者名
tags标签数组
is_draft是否草稿

正文规范

标题层级

使用 ## 作为一级章节标题,### 作为子节。不要在正文中使用 #(它保留给页面标题)。

代码块

代码块必须指定语言,以获得语法高亮:

def parse_markdown(content: str) -> dict:
    """解析 Markdown 为发布读模型"""
    metadata, body = content.split("---", 2)[1:]
    return {"metadata": metadata, "body": body.strip()}

引用

这是一段引用。引用可以用来强调关键观点,或者摘录他人的论述。

引用支持多段落。

图片

图片只存 URL 元数据,使用已有 GitHub 图床:

中子星示意图

首屏图片必须明确尺寸,正文图片默认懒加载。

发布流程

  1. content/posts/ 下创建 Markdown 文件
  2. 填写完整 frontmatter
  3. 提交并推送到 GitHub
  4. Webhook 自动触发热发布,1~3 秒内生效
  5. 发布失败时保留上一版,可重试

注意事项

  • 不要在文章中使用绝对本地路径
  • 图片文件名避免中文、空格和特殊符号
  • 不覆盖已发布的同名图片,优先使用新文件名
  • 文章内容不执行任意 HTML,所有 HTML 会被清理