📝 如何在 Angelic Wiki 中添加文章
本站所有文章均以 Markdown (.md) 文件形式统一保存在 content/ 目录下。添加或更新文章非常简单,只需遵循以下几个步骤:
步骤 1:确定文件路径与分类
根据文章主题选择或创建对应的分类目录:
content/
├── 药物索引/ # 放置药物药理、科普、成分说明文档
│ ├── 新药物名称.md
├── 维护教程/ # 放置站点维护、协作手册与格式规范
│ └── 新教程名称.md
└── 新分类名/ # 如需新增顶级分类,直接新建文件夹即可
└── 文章名称.md命名规范
- 推荐直接使用清晰的中文或英文命名,例如:
右美沙芬.md、排版规范.md。- 避免文件名包含
/、\、?、*等系统保留非法字符。
步骤 2:编写 Frontmatter(文章元数据)
每篇新建的 Markdown 文件最顶部必须包含三条短横线包围的 Frontmatter,用于定义网页标题与摘要:
---
title: 文章标题
description: 简短的一句话描述(用于 SEO 检索及悬停卡片预览)
tags:
- 核心标签1
- 分类标签2
aliases:
- 药物别名或简写
draft: false
---字段说明:
title(必填):显示在网页最上方的大标题,以及侧边栏和浏览器标签页上。description(推荐):文章简短摘要,在链接悬停弹窗(Popover)及搜索引擎 SEO 中展示。tags(可选):文章标签,会自动显示在页面顶部的 Properties(属性面板) 中并归入全站标签体系。aliases(可选):页面别名,同样会收录在顶部的 Properties 面板 中,支持以别名被双链引用。draft(可选):若设为true,该文章为草稿状态,打包时不会公开发布;发布时设为false或直接删除该字段。
Quartz 5 新特性:可折叠的 Properties(属性面板)
Quartz 5 深度还原了 Obsidian 的 Properties 功能(由官方
@quartz-community/note-properties插件驱动)。 它会自动在文章标题下方生成一个可折叠的属性面板,整齐展示本文的tags(标签)与aliases(别名),读者点击即可展开或折叠。
步骤 3:编写正文内容
在 Frontmatter 之后即可开始撰写正文。推荐在最上面使用一级标题并添加简介:
# 💊 药物名称
**药物名称**(英文通用名:Drug Name)是一种……
> [!important] 核心重点
>
> 这里放置最需要引起读者注意的重要事实或警示。
---
## 1. 药理作用机制
正文内容……具体的语法样式与排版样例,请参考:👉 《排版与格式规范》。 如果是编写药物科普与减害条目,请直接查阅与复制标准模板:👉 《药物条目编写规范与标准模板》。
步骤 4:本地预览验证
在 VS Code 中直接按下快捷键 F5,本地开发服务会自动启动并呼出浏览器。在左侧边栏即可即时查看新文章的渲染效果,保存文件会自动热重载刷新。
步骤 5:提交与发布
编写并确认无误后,通过终端将文件推送到 GitHub:
git add content/
git commit -m "docs: 新增《XXX》科普文章"
git push origin v5:mainGitHub Actions 会自动触发云端静态构建,1~2 分钟后即可在公网域名 angelic.today 上查看到最新内容。