如何新增或修订条目
如何新增或修订条目
Section titled “如何新增或修订条目”本站所有内容都是仓库里的普通文本文件,改完推上去就会自动上线。
一、词条文件放在哪
Section titled “一、词条文件放在哪”src/content/docs/├── index.mdx 中文首页├── start/ 使用指南├── encyclopedia/ 中文词条│ ├── index.mdx 词条总览│ ├── medical-humanities.md 医学人文│ ├── narrative-medicine.md 叙事医学│ ├── rita-charon.md Rita Charon│ └── social-prescribing.md 社会处方├── about/ 关于与免责声明└── en/ 英文版,目录结构完全对应 ├── index.mdx ├── start/ ├── encyclopedia/ └── about/规则:中文和英文的目录结构、文件名必须一一对应。 中英双语站最容易出的问题就是一边改了另一边忘了改。
二、词条长什么样
Section titled “二、词条长什么样”每个词条是一个 .md 文件,开头是一段属性信息:
---title: 医学人文description: 用人文学科的方法理解、研究与改进医学实践的跨学科领域。sidebar: label: 医学人文 badge: 初稿待复核 variant: caution---
## 一句话解释
正文从这里开始。常用字段:
| 字段 | 作用 | 必填 |
|---|---|---|
title |
词条标题,也是搜索用的名字 | 是 |
description |
搜索结果里的摘要,建议 60 字以内 | 是 |
sidebar.label |
左侧导航里显示的名字 | 否 |
sidebar.badge |
导航里的角标,例如「初稿待复核」 | 否 |
sidebar.variant |
角标颜色:caution / tip / danger / success |
否 |
三、推荐的词条结构
Section titled “三、推荐的词条结构”按这个顺序写,读者最容易读懂:
- 一句话解释 —— 用
[!note]风格的提示块给出核心定义 - 背景与来源 —— 这个概念从哪来,谁提出的
- 主要内容 —— 分点展开,控制在 3–5 个二级标题
- 争议与不同看法 —— 学术上有分歧的地方
- 在中国语境的讨论 —— 如果适用
- 延伸阅读 —— 列出可核查的来源
四、发布流程
Section titled “四、发布流程”改文件 → 本地预览 → 提交 → 推送 → 自动上线本地预览(在项目目录下运行):
npm installnpm run dev然后在浏览器打开 http://localhost:4321/,中文在根路径,英文在 /en/。
确认没问题后:
git add .git commit -m "新增词条:XX"git push推送后托管平台会自动重新构建并发布,通常一两分钟。
五、人工复核是硬要求
Section titled “五、人工复核是硬要求”六、常见问题
Section titled “六、常见问题”改了没生效? 推送之后等待一两分钟自动构建。若长时间无变化,检查推送是否真的完成。
英文版漏改了?
修改中文文件后,同步修改 src/content/docs/en/ 下的同名文件。
想改导航顺序?
在 astro.config.mjs 的 sidebar 中调整。中文和英文各写一份,英文侧用 translations 字段。