✅ 本规范适用于
BYPsNotes知识库所有.md笔记文件 ✅ 所有功能均已通过测试(2026-05-03),无需额外配置
遵循本规范的笔记具有以下优势:
.md 文件,在 Obsidian / Typora / VS Code 中完美显示厄尔尼诺现象.md 而非 note1.md-)extern/notes/
├── 地球知识/
│ ├── 大气现象/
│ │ ├── 大气现象.md # 主笔记
│ │ ├── 厄尔尼诺现象.md # 子主题
│ │ └── 大气环流.md
├── 卫星遥感/
│ └── 数据资源/
│ └── NOAA极轨卫星历史.md
└── 标准规范/
└── 标准查询.md
每个笔记文件开头必须包含 --- 包裹的元数据!
---
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"] |
--- 必须是文件的前两行内容title 和 date 是必须填写的字段source_name 配合 source 使用,显示更美观tags 可以为空数组 []# 一级标题(文章主标题,仅一个)
## 二级标题(章节标题)
### 三级标题(子章节)
#### 四级标题(一般不推荐使用)
# 与标题文字之间必须有空格#)<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 |
🟣 紫色 | 特殊、标注 |
<span style="color:red"> 内联样式{: .text-red } 语法(在列表、段落中不生效)<span class="text-XX"> 标签,100%可靠```python
def hello():
print("Hello BYP!")
```
常用语言:python、javascript、html、css、json、yaml、markdown、bash
分隔线(---)用于在视觉上分隔不同的章节或内容块。
## 章节一
内容...
---
## 章节二
内容...
---
## 章节标题
---
内容...

| 类型 | 路径示例 | 说明 |
|---|---|---|
| 全局附件 | /attachments/images/... |
extern/attachments/images/ |
| 笔记附件 | /attachments/images/高校院所/... |
按分类组织 |
| PDF文件 | /attachments/docs/标准规范/... |
参考文献等 |
系统 CSS 已内置响应式规则:
| 设备 | 最大宽度 |
|---|---|
| 桌面端(≥769px) | 768px |
| 移动端(≤768px) | 100% |
/ 开头的绝对路径alt 文字描述[NOAA官网](https://www.cpc.ncep.noaa.gov)
[气候变化](/note/extern/气候变化/气候变化.html)
[厄尔尼诺现象](/note/extern/地球知识/大气现象/厄尔尼诺现象.html)
/note/extern/分类路径/文件名.html.html 后缀,而不是 .md 后缀(Flask 路由要求)extern/notes/气候变化/气候变化.md → 链接为 /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 已包含 | 避免重复 |
新建或修改笔记时,请确认:
title + date)title 和 date 字段已填写#)<span class="text-XX"> 格式*最后更新:*)📝 最后更新:2026-05-03
🛠️ 技术支持:app.py 启用 ['extra', 'fenced_code', 'attr_list'] 扩展
🎨 样式定义:static/css/note.css 中 .text-* 类