行间English

写作与发布流程

发布于 · 教程#workflow#mdx

本文暂无英文版。

文章文件的格式

每篇文章是一个 .mdx 文件,存放在 content/posts/<语言>/ 目录下,文件名与 slug 一致。文件开头是一段 frontmatter,用来描述文章的元信息:

title_zh: 写作与发布流程
slug: xiezuo-yu-fabu-liucheng
translation_key: content-workflow
lang: zh
date: 2026-11-04
section: tutorial
tags: [workflow, mdx]
summary: 一句话说明这篇文章讲什么。
draft: false

其中 summary 是必填项,会显示在文章顶部的「简要说明」框中,也用于列表页、RSS 和搜索结果。

从草稿到发布

第一步:放入待评审区

新文章先写在 inbox/ 目录。这里的文件不会被构建,也不会出现在站点上。

第二步:评审后移入内容目录

评审通过后,把文件移到 content/posts/ 下对应的语言目录。

第三步:运行检查

发布前在本地运行一条命令:

npm run verify

它会依次执行内容检查、类型检查、代码规范检查、单元测试和生产构建。内容检查会拦截以下问题:

  • frontmatter 缺少必填字段或格式错误;
  • 同一个 translation_key 在同一种语言下出现多篇,或中英文栏目不一致;
  • 正文中的站内链接指向不存在的文章;
  • 引用的图片不存在或体积超过上限。

只有全部通过,才能合并到主分支并发布。

关于英文版

本文暂时只有中文版,因此在文章顶部你会看到缺少英文版的提示。这也是本站处理缺译文章的方式。