格式类型 | 前缀/后缀 | 解析方式 | 推荐支持 |
---|---|---|---|
YAML | --- ... --- | yaml.safe_load | 推荐 |
JSON | ;;; ... ;;; 或 --- {...} --- | json.loads | 建 议 |
TOML | +++ ... +++ | toml.loads | 建议 |
INI | ;;; ... ;;; | configparser | 可选 |
字段名 | 解释 |
---|---|
title | 标题 |
css | 自定义的css样式链接, 不传会使用一个默认的css样式,支持相对路径的写法(相对路径需要使用zip格式数据请求而且对应相对路径下文件存在) |
js | 自定义外部js链接 支持相对路径的写法(相对路径需要使用zip格式数据请求而且对应相对路径下文件存在) |
description | |
favicon | |
theme | 主题颜色 |
image | opengraph 的图片 |
---
title: 测试文档
author: 张三
date: 2025-05-15
css:
- https://cdn.jsdelivr.net/npm/github-markdown-css/github-markdown.min.css
- /static/custom.css
js:
- https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js
- /static/my-script.js
description: 这是一个用 于测试 YAML 元数据头解析的 Markdown 示例文件。
---
# 你好,世界!
这是正文内容,用于测试你的元数据解析代码。
- 这是一条列表
- 这也是一条列表
> 引用内容