Quartz & Obsidian 文档模板参考
模板说明
本文件是基于 Quartz 与 Obsidian 构建的 GitHub Pages 项目的标准化文档模板参考。包含 8 种常见页面类型的模板结构，每种模板均包含必要的元数据字段、标准内容结构、排版规范和可选扩展模块。
1. 个人博客模板
元数据字段
title: "博客标题"
date: "YYYY-MM-DD"
tags: [标签1, 标签2, 标签3]
categories: "分类"
summary: "简短摘要"
author: "作者"
slug: "自定义链接"内容结构
# 博客标题
## 摘要
简短介绍文章主题...
## 正文第一节
内容...
## 正文第二节
内容...
## 结论
总结要点...
## 相关链接
- [链接1](URL)
- [链接2](URL)扩展模块
- 系列文章：相关文章链接
- 评论区：Disqus 或其他评论系统
- 分享按钮：社交媒体分享
2. 项目文档模板
元数据字段
title: "文档标题"
date: "YYYY-MM-DD"
tags: [标签1, 标签2, 标签3]
categories: "Documentation"
version: "1.0.0"
status: "Published"
maintainer: "维护者"内容结构
# 文档标题
## 概述
项目简介和目标...
## 安装指南
1. 步骤1
2. 步骤2
3. 步骤3
## 使用方法
基本操作和示例...
## 配置选项
可配置参数说明...
## 常见问题
FAQ 部分...
## 贡献指南
如何参与项目...扩展模块
- API 参考：详细接口说明
- 变更日志：版本更新记录
- 路线图：未来计划
3. 学习笔记模板
元数据字段
title: "笔记标题"
date: "YYYY-MM-DD"
tags: [标签1, 标签2, 标签3]
categories: "Notes"
course: "课程名称"
instructor: "讲师"
priority: "High"内容结构
# 笔记标题
## 学习目标
本次学习的重点...
## 核心概念
关键知识点...
## 示例代码代码示例…
## 疑问点
未理解的内容...
## 总结
学习收获...
## 复习计划
后续学习安排...
扩展模块
- 参考资料：书籍、文章链接
- 练习题目：巩固练习
- 思维导图：知识结构可视化
4. 知识库条目模板
元数据字段
title: "条目标题"
date: "YYYY-MM-DD"
tags: [标签1, 标签2, 标签3]
categories: "Knowledge Base"
aliases: [别名1, 别名2]
related: [相关条目1, 相关条目2]
status: "Active"内容结构
# 条目标题
## 定义
条目核心概念...
## 背景
历史和上下文...
## 应用场景
使用情况...
## 相关概念
关联知识...
## 参考资料
来源链接...扩展模块
- 术语表：相关术语解释
- 案例研究：实际应用例子
- 常见误区：容易混淆的点
5. 教程指南模板
元数据字段
title: "教程标题"
date: "YYYY-MM-DD"
tags: [标签1, 标签2, 标签3]
categories: "Tutorial"
difficulty: "Beginner"
estimated_time: "30 minutes"
prerequisites: [前置条件1, 前置条件2]内容结构
# 教程标题
## 简介
教程目标和预期成果...
## 准备工作
所需工具和环境...
## 步骤
1. **步骤1**：详细操作
2. **步骤2**：详细操作
3. **步骤3**：详细操作
## 验证
验证结果的方法...
## 故障排除
常见问题解决...
## 进阶内容
扩展学习方向...扩展模块
- 视频教程：配套视频链接
- 练习项目：实践任务
- 资源下载：相关文件下载
6. 资源清单模板
元数据字段
title: "清单标题"
date: "YYYY-MM-DD"
tags: [标签1, 标签2, 标签3]
categories: "Resources"
last_updated: "YYYY-MM-DD"
source: "来源"
purpose: "用途"内容结构
# 清单标题
## 简介
清单目的和范围...
## 分类
### 分类1
- 资源1：描述 [链接](URL)
- 资源2：描述 [链接](URL)
### 分类2
- 资源1：描述 [链接](URL)
- 资源2：描述 [链接](URL)
## 使用建议
如何有效利用...
## 更新记录
变更历史...扩展模块
- 评分系统：资源质量评估
- 使用案例：资源应用示例
- 贡献指南：如何添加新资源
7. 会议记录模板
元数据字段
title: "会议标题"
date: "YYYY-MM-DD"
tags: [标签1, 标签2, 标签3]
categories: "Meeting Notes"
time: "14:00-15:30"
attendees: [参会人员1, 参会人员2]
location: "会议地点"内容结构
# 会议标题
## 会议信息
- **时间**：YYYY-MM-DD HH:MM-HH:MM
- **地点**：会议地点
- **参会人员**：参会人员1, 参会人员2
## 议程
- 议程项目1
- 议程项目2
- 议程项目3
## 讨论内容
详细讨论记录...
## 决策事项
达成的决议...
## 行动项
| 任务 | 负责人 | 截止日期 |
|------|--------|----------|
| 任务1 | 负责人1 | YYYY-MM-DD |
| 任务2 | 负责人2 | YYYY-MM-DD |
## 下次会议
时间和议程预告...扩展模块
- 会议材料：相关文档链接
- 录音链接：会议录音（如适用）
- 会议纪要：简明摘要
8. 每日日志模板
元数据字段
title: "YYYY-MM-DD 日志"
date: "YYYY-MM-DD"
tags: [标签1, 标签2, 标签3]
categories: "Daily Log"
mood: "Good"
weather: "晴天"内容结构
# YYYY-MM-DD 日志
## 今日完成
- [x] 任务1
- [x] 任务2
- [ ] 任务3
## 明日计划
- [ ] 任务1
- [ ] 任务2
- [ ] 任务3
## 遇到的问题
挑战和困难...
## 学习收获
新知识和技能...
## 反思
思考和感悟...
## 其他
杂项记录...扩展模块
- 习惯追踪：日常习惯记录
- 健康状况：身体状况记录
- 成就记录：小成就和进步
使用说明
- 选择模板：根据内容类型选择合适的模板
- 填充元数据：修改 YAML 前置元数据中的占位符
- 编写内容：按照模板结构填充实际内容
- 添加扩展：根据需要添加相应的扩展模块
- 验证渲染：使用
npx quartz build构建项目并检查渲染效果
维护建议
- 定期更新模板以适应项目需求变化
- 保持模板结构的一致性和可扩展性
- 在使用过程中收集反馈并持续改进
- 为新的内容类型添加相应的模板
通过使用这些标准化模板，可以确保项目文档的一致性和专业性，提高内容创作效率和页面渲染质量。