README file from
GithubNote Calendar - Obsidian日历插件
介绍
这是一个Obsidian日历插件,支持显示农历、节日、调休、节气等信息,支持现有笔记的更新/新增显示和创建日历关联的笔记。
功能特性
-
日历视图:支持公历、农历、调休、节气、节假日等信息的显示,支持月视图和年视图的切换。
-
笔记管理:支持获取笔记属性,显示笔记新增/更新汇总,自动刷新笔记列表,绿色圆点表示新增,蓝色圆点表示更新。
-
笔记创建:支持创建日记、周周记、季度笔记、年度笔记,笔记名称格式支持自定义。
-
快速创建:支持在日历视图中直接创建笔记,点击笔记列表中的按钮即可创建不同类型的笔记。
-
响应式设计:适配不同屏幕尺寸,提供良好的用户体验。
插件设置说明
基本设置
- 一周起始日:选择日历一周的第一天是周日还是周一
- 周末颜色:设置周六和周日显示的颜色
- 主题颜色:设置今天、选中状态和节假日的显示颜色
- 字体:选择日历使用的字体,支持默认、微软雅黑、宋体、黑体、Arial、Helvetica、Verdana、Tahoma、Segoe UI
- 字号:设置日历文字大小(10-20px)
显示设置
- 是否显示公历假日:控制是否显示公历节假日信息
- 是否显示调休:控制是否显示调休信息
- 是否显示农历日期:控制是否显示农历日期、月份、年份
- 是否显示农历假日:控制是否显示农历节假日信息
- 是否显示农历节气:控制是否显示农历节气信息
笔记设置
- 笔记文件夹路径:设置扫描笔记的文件夹路径(留空为根目录)
- 日期格式:设置新建笔记的默认日期格式,支持 YYYY-MM-DD、YYYY/MM/DD、DD/MM/YYYY、MM/DD/YYYY
- 重新扫描笔记:点击按钮重新扫描所有笔记,根据笔记新增和修改时间,更新笔记状态。
使用方法
基本操作
-
导航日期:使用日历顶部的箭头按钮可以导航到上一个月/年或下一个月/年。
-
查看笔记:点击日历上的日期可以查看当天的笔记列表。
笔记创建
-
创建日记:点击笔记列表中的 "+" 按钮,在弹出的对话框中输入标题和文件夹路径,点击确认即可创建。
-
创建周周记:点击笔记列表中的 "周" 按钮,系统会自动生成格式为 "YYYY-n周" 的默认标题。
-
创建季度笔记:点击笔记列表中的 "季" 按钮,系统会自动生成格式为 "YYYY年-n季度" 的默认标题。
-
创建年度笔记:点击笔记列表中的 "年" 按钮,系统会自动生成格式为 "YYYY" 的默认标题。
笔记管理
-
自动刷新:当新建、修改、重命名或删除笔记时,日历会自动刷新,显示最新的笔记状态。
-
笔记列表:显示当前选中日期的所有笔记,点击笔记名称可以直接打开笔记。
安装指南
方式一:手动安装
-
下载插件:从发布页面下载最新版本的插件压缩包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