README file from
GithubNote Calendar - Obsidian日历插件
本插件已经上架Obsidian 社区插件市场,欢迎大家使用和反馈。
本人是obsidian和前端的初学者,初次接触obsidian,对前端技术也比较生疏,所以这个插件的实现和功能上有一些不足,希望大家多多包涵,也欢迎一起参与讨论或对插件的改进提出批评和建议。
TODO LIST
以下功能待实现,后续版本迭代中逐步实现(非顺序),欢迎大家一起参与贡献。
- 多视图支持:月视图、周视图、年视图切换
- 创建笔记支持添加模板:支持 templater 插件模板
- 待办任务关联日历
- 支持task插件
- 支持国际化
- 布局优化
- 日历独立悬浮窗口
- 日历弹出为独立小窗,查看当日任务/文件,点击可切回主窗口
- 支持老黄历的显示
- 支持特定人群日历切换
- 支持佛历的显示
- 支持道历的显示
- 支持移动端
更新日志
v1.4.0 — Templater 模板集成与交互优化(2026-09-14)
- 五类笔记支持 Templater 模板,创建时自动套用并渲染(可选依赖,未安装不影响任何功能)
- 配置页面新增文件夹/模板文件选择器,路径无效时输入框红色提示
- 笔记列表增强:按更新时间排序、数量统计、类型标签与笔记路径
- 设置面板支持分组收起、一键恢复默认
- 主题色支持跟随 Obsidian 强调色
v1.3.1 — 内部重构(2026-08-07)
- 纯内部重构,无功能变化
v1.3.0 — 创建笔记文件夹筛选(2026-08-05)
- 创建笔记弹窗的文件夹路径支持输入筛选
- 新增 📁 文件夹选择器(树状懒加载),自动滚动定位
v1.2.0 — 月度笔记与季度自定义(2026-07-28)
- 新增月度笔记创建与配置
- 日历标题季度显示(数字/季节/自定义命名)
- 笔记列表增加农历日期显示
v1.1.0 — 笔记配置与内联改造(2026-07-24)
- 各类笔记独立配置标题格式和默认路径
- lunar.js 内联到 main.js,插件完全自包含
- 导航按钮美化,标题居中布局优化
v1.0.5 — 修复已知问题(2026-07-24)
- 固定日历头部,笔记列表独立滚动
v1.0.4 — 新增功能(2026-07-15)
- 新增主题模式设置(跟随 Obsidian / 深色 / 浅色)
v1.0.3 — 修复与优化(2026-07-08)
- 使用 Obsidian 原生 CSS 变量替换硬编码颜色
- 修正 lunar.js 路径拼接问题
介绍
一个 Obsidian 日历插件,支持公历、农历、节日、调休、节气的显示,自动将笔记创建/修改日期关联到日历,并支持一键创建日记、周记、月记、季记和年记。
功能特性
-
日历视图:月视图,淡紫色调,显示周数、公历、农历、节日、节气、调休班休标记。
-
笔记关联:自动扫描仓库笔记,按创建/修改日期标记到日历上(绿色=新增,蓝色=更新)。
-
笔记创建:支持日记、周记、月度笔记、季度笔记、年度笔记五种类型,标题格式和保存路径各自独立配置,弹窗文件夹路径支持筛选选择。
-
季度自定义:日历标题可显示当前季度,支持数字(1季度)、季节(春季)或自定义命名,首季起始月可调。
-
颜色管理:主题色和周末色支持自定义,一键重置为默认。
-
模板支持(可选):集成 Templater 插件,创建五类笔记时自动套用模板;未安装 Templater 不影响任何现有功能。
插件设置说明
外观
- 主题模式:跟随Obsidian / 深色 / 浅色
- 一周起始日:周日或周一
- 周末颜色 / 主题颜色:可自定义,点击旁 ⟳ 按钮还原默认
- 字体 / 字号:11种字体,字号 10-20px
显示
- 公历假日、调休、农历日期、农历假日、节气 — 各独立开关
季度显示设置
- 季度显示模式:数字(1季度)/ 春夏秋冬(春季)/ 自定义命名
- 首季起始月份:季节/自定义模式下设置第一个季度从哪月开始
- 自定义季度名称:逗号分隔4个名称,不足自动补齐
五类笔记设置(日记 / 周记 / 月度 / 季度 / 年度)
- 每类独立配置标题格式(支持 YYYY / MM / DD / {week} / {quarter} 等变量)
- 每类独立配置默认文件夹路径,路径项旁 📁 按钮可弹出文件夹选择窗口自动填充
- 每类独立配置模板文件(需 Templater 插件,见下方"模板支持"),路径项旁按钮可弹出文件选择窗口,路径填写错误时输入框显示红色边框
笔记扫描
- 扫描目录:限定只扫描某目录下的笔记(留空=全库),与创建笔记的保存路径无关,支持 📁 按钮选择
- 手动扫描:点击立即重新扫描
使用方法
基础操作
- 点击
‹‹‹›››切换月/年 - 点击「今」回到今天
- 点击任意日期查看当天笔记列表
创建笔记
列表顶部按钮 [+ 周 月 季 年],分别创建对应类型笔记,弹窗中可修改标题和保存路径,文件夹路径支持输入筛选和 📁 树状选择。
笔记管理
- 新建、修改、重命名、删除笔记时自动刷新
- 点击笔记名称直接打开对应文件
模板支持(Templater,可选)
本插件可选集成 Templater 插件:创建日记/周记/月记/季记/年记时自动套用模板。不安装 Templater 不影响本插件任何现有功能。
前提:安装并启用社区插件 Templater。
配置步骤:
-
用 Templater 语法写一个模板文件(普通 .md 文件即可,不要求放在 Templater 的模板目录内),例如
templates/日记模板.md:--- created: <% tp.date.now("YYYY-MM-DD HH:mm") %> type: daily --- # <% tp.file.title %> -
打开本插件设置 → 日记设置 → 模板文件,填入该文件路径(或点击旁边的按钮在文件选择窗口中选择)
-
点击日历笔记列表的
+创建笔记,内容即为模板渲染结果
行为说明:
- 模板路径留空 = 创建空笔记(默认行为,与未安装 Templater 时一致)
<% tp.file.title %>会替换为弹窗中最终确定的标题- 模板文件不存在或渲染失败:保留空笔记并弹出提示,不会中断创建流程
- 若你在 Templater 中开启了"文件夹模板"(Folder Templates)并指向笔记的保存目录,本插件会自动跳过自己的模板套用,避免内容重复(建议只在一处配置)
安装指南
方式一:手动安装
-
下载插件:从发布页面下载最新版本的插件压缩包note-calendar.zip。
-
安装插件:将插件压缩包note-calendar.zip解压,解压后的文件夹名称为note-calendar,将其放入Obsidian的插件目录中。
-
启用插件:在Obsidian中打开设置,找到插件列表,启用"Note Calendar"插件。
方式二:使用Obsidian社区插件市场安装
-
打开Obsidian社区插件市场:在Obsidian中打开设置,找到社区插件市场。
-
搜索插件:在插件市场中搜索"Note Calendar"插件。
-
安装插件:点击插件列表中的"安装"按钮,确认安装。
-
启用插件:在Obsidian中打开设置,找到插件列表,启用"Note Calendar"插件。
反馈
-
问题反馈:如果在使用过程中遇到问题,请在GitHub Issues中提交问题报告。
-
功能建议:如果有任何功能建议或改进意见,请在GitHub Issues中提交建议。
依赖组件
1.lunar 组件
lunar是一款无第三方依赖的公历(阳历)、农历(阴历、老黄历)、佛历和道历工具 github地址:https://github.com/6tail/lunar-javascript 文档地址:https://6tail.cn/calendar/api.html