笔记 Markdown 文件编写规范

✅ 本规范适用于 BYPsNotes 知识库所有 .md 笔记文件 ✅ 所有功能均已通过测试(2026-05-03),无需额外配置


一、为什么要遵循规范?

遵循本规范的笔记具有以下优势:


二、文件组织

文件命名

目录结构

extern/notes/
├── 地球知识/
│   ├── 大气现象/
│   │   ├── 大气现象.md          # 主笔记
│   │   ├── 厄尔尼诺现象.md      # 子主题
│   │   └── 大气环流.md
├── 卫星遥感/
│   └── 数据资源/
│       └── NOAA极轨卫星历史.md
└── 标准规范/
    └── 标准查询.md

三、frontmatter 元数据(必须)

每个笔记文件开头必须包含 --- 包裹的元数据!

标准格式

---
title: "笔记标题"
date: "2026-05-03"
source: "https://example.com/source"
source_name: "来源名称"
description: "笔记简短描述"
tags: ["标签1", "标签2"]
---

字段说明

字段 必填 说明 示例
title 笔记标题,会覆盖正文中的 # 标题 "厄尔尼诺现象"
date 笔记日期(格式:YYYY-MM-DD) "2026-05-03"
source 来源链接,点击可跳转 "https://ouc.edu.cn/31005/"
source_name 来源显示名称(推荐添加) "中国海洋大学官网"
description 简短描述,用于列表页显示 "厄尔尼诺现象简介"
tags 标签数组,用于分类检索 ["气象", "ENSO"]

注意事项


四、标题层级

正确示例

# 一级标题(文章主标题,仅一个)
## 二级标题(章节标题)
### 三级标题(子章节)
#### 四级标题(一般不推荐使用)

注意事项


五、颜色与样式(使用 span 标签)

推荐用法:<span> 标签

<span class="text-red">红色文字</span>
<span class="text-blue">蓝色文字</span>
<span class="text-orange">橙色文字</span>
<span class="text-green">绿色文字</span>
<span class="text-cyan">青色文字</span>
<span class="text-purple">紫色文字</span>

可用样式类

类名 效果 适用场景
.text-red 🔴 红色 警示、重点强调
.text-blue 🔵 蓝色 链接、引用
.text-orange 🟠 橙色 分类标记
.text-green 🟢 绿色 成功、正面
.text-cyan 🔷 青色 信息、补充
.text-purple 🟣 紫色 特殊、标注

注意事项


六、代码块

标准格式

```python
def hello():
    print("Hello BYP!")
```

支持的语言标识

常用语言:pythonjavascripthtmlcssjsonyamlmarkdownbash

注意事项


七、分隔线

使用原则

分隔线(---)用于在视觉上分隔不同的章节或内容块。

正确用法

## 章节一

内容...

---

## 章节二

内容...

错误用法

---

## 章节标题

---

内容...

注意事项


八、图片与附件

Markdown 图片语法

![图片描述](图片路径)

附件路径规范

类型 路径示例 说明
全局附件 /attachments/images/... extern/attachments/images/
笔记附件 /attachments/images/高校院所/... 按分类组织
PDF文件 /attachments/docs/标准规范/... 参考文献等

缩略图效果

系统 CSS 已内置响应式规则:

设备 最大宽度
桌面端(≥769px) 768px
移动端(≤768px) 100%

注意事项


九、链接

外部链接

[NOAA官网](https://www.cpc.ncep.noaa.gov)

内部链接(绝对路径)

[气候变化](/note/extern/气候变化/气候变化.html)
[厄尔尼诺现象](/note/extern/地球知识/大气现象/厄尔尼诺现象.html)

注意事项


十、表格

标准格式

| 列1 | 列2 | 列3 |
|------|------|------|
| 内容1 | 内容2 | 内容3 |
| 内容4 | 内容5 | 内容6 |

注意事项


十一、常见错误避免

❌ 错误写法 ✅ 正确写法 说明
##二级标题 ## 二级标题 # 后需加空格
<span style="color:red"> <span class="text-red"> 禁止内联样式
{: .text-red } <span class="text-red"> 不推荐 attr_list 语法
省略 frontmatter 必须包含 title 和 date 元数据必填
使用 *最后更新* 不需要,frontmatter 已包含 避免重复

十二、快速检查清单

新建或修改笔记时,请确认:


📝 最后更新:2026-05-03 🛠️ 技术支持:app.py 启用 ['extra', 'fenced_code', 'attr_list'] 扩展 🎨 样式定义:static/css/note.css.text-*

相关链接