如何发布教程与资源
站长/投稿人的内容发布指南:教程的 Markdown 模板、资源发布流程、发版脚本用法与上线检查清单。
站务说明发布于 2026年9月4日约 9 分钟读完#发布#指南#站务
这篇文档说明怎么往本站发内容。发教程只需要会写 Markdown,发资源多一步跑脚本。
一、发布教程
在 content/tutorials/<分类>/<英文slug>.md 新建文件即可。分类目录名(见 app.config.ts):
getting-started(入门准备)/ framework(框架安装)/ database(数据库)/ faq(常见问题)/ dev(进阶开发)/ meta(站务说明)
文章模板:
---
title: 文章标题
description: 一句话摘要,会显示在列表和搜索结果里
category: 数据库
tags: [MySQL, 新手]
date: 2026-09-04
---
## 第一个标题
正文,支持标准 Markdown。
## 内嵌 B 站视频(可选)
::bili{bv="BV1xxx411x7xx"}::
## 内部链接
链接其他教程用站内路径:[常见报错速查表](/tutorials/faq/common-errors)
frontmatter 字段说明:
| 字段 | 必填 | 说明 |
|---|---|---|
title | ✅ | 标题 |
description | 建议 | 摘要,列表/SEO 用 |
category | 建议 | 中文分类名,用于展示 |
tags | 建议 | 标签数组 |
date | ✅ | 发布日期 YYYY-MM-DD |
updated | 可选 | 更新日期,有修改时更新它 |
bilibili | 可选 | B 站 BV 号,填了会在文首内嵌播放器 |
draft | 可选 | true 时全站隐藏(草稿) |
二、发布资源
一个资源 = 一个介绍页 + N 个发布版本。
第一步:写介绍页 —— 在 content/resources/<英文slug>.md 新建:
---
title: 资源名称
description: 一句话说明这是什么
category: 脚本插件
tags: [标签1, 标签2]
cover: /images/covers/xxx.svg # 可选,封面图放 public/images/
screenshots: [] # 可选,截图数组
github: https://github.com/you/repo # 可选
gitee: https://gitee.com/you/repo # 可选,国内镜像
featured: true # 是否在首页"精选资源"展示
date: 2026-09-04
---
正文:介绍 + 安装说明(Markdown)。
第二步:发版本 —— 把 zip 包发给用户下载:
# 用法:npm run release -- <资源slug> <版本号> <zip文件路径> [--notes "更新说明"]
npm run release -- server-starter-kit v1.1.0 ./dist/server-starter-kit.zip --notes "新增 permissions.cfg"
脚本会自动:复制 zip 到 data/files/<slug>/ → 计算 SHA-256 与文件大小 → 更新 data/resources/<slug>/releases.json。资源页会立刻显示新版本、下载按钮和校验值。
三、本地预览与上线
npm run dev # 本地 http://localhost:3000 预览
npm run build # 构建(上线/内容更新后都要重新 build)
上线与更新流程见项目根目录的 DEPLOY.md。
