MCPcopy Index your code
hub / github.com/Moyf/yearly-glance

github.com/Moyf/yearly-glance @4.2.5

Chat with this repo
repository ↗ · DeepWiki ↗ · release 4.2.5 ↗ · + Follow
572 symbols 1,266 edges 89 files 86 documented · 15%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Yearly Glance:时光不漏,一眼尽览

中文文档 | English

GitHub stars Total Downloads GitHub Issues GitHub Last Commit

Yearly Glance 是一款 Obsidian 年度事件一览插件,帮助你高效规划、回顾和管理全年的重要日期,支持高度自定义和多种事件类型。

preview


快捷目录

功能亮点

  • 🗓️ 年度日历视图:一屏尽览全年日历,年度规划一目了然
  • 🎉 多事件类型:支持节日、生日、自定义事件等
  • 🎂 生日管理:记录年龄、生肖、星座等属性
  • 🎨 高度可定制:多种布局与配色风格,支持 emoji
  • 🖱️ 交互界面:点击即可查看和编辑事件
  • 🔍 事件筛选:按类型过滤、隐藏空日期
  • 🌙 农历支持:原生支持中国农历
  • 🌏 多语言:支持简繁中文和英文语言
  • 📄 笔记事件:使用带有 frontmatter 属性的笔记作为事件来源,支持 Bases 集成实现高级筛选。了解更多

事件来源模型

Yearly Glance 支持多种事件来源,你可以根据不同使用场景选择合适的存储方式:

来源 存储位置 适合场景
插件事件 插件数据 快速管理节日、生日和自定义事件
笔记事件 笔记 frontmatter 需要独立笔记、详细正文、链接或附件的事件
日记事件 日记 frontmatter 和 Daily Notes、日记工作流绑定的事件
Bases 视图 .base 查询结果 嵌入笔记内、根据条件筛选事件

关于 frontmatter 配置和 Bases 集成,请查看笔记事件文档

截图展示

列表视图

details

灵活的事件列表管理界面

日历视图

calendar

经典日历布局,直观查看全年事件

事件过滤

filter

按类型筛选,隐藏空日期,支持高亮显示重要事件

查看和编辑事件

edit

便捷的事件编辑窗口

快速上手

1. 打开年度概览

  • 点击左侧边栏🔭望远镜图标
  • 或使用命令面板搜索“打开年度概览”
  • 或使用快捷键(如已设置)

2. 查看事件

  • 不同颜色代表不同事件类型
  • 点击事件查看详情
  • 点击 🗂️ 管理按钮打开事件管理器查看所有事件

3. 添加事件

  • 通过命令面板选择“管理事件”,点击右上角 ➕ 按钮添加
  • 或者直接在概览视图中将鼠标移到指定日期,点击出现的 + 按钮
  • 你也可以在命令面板中选择“添加事件”

4. 管理事件

  • 通过命令面板打开事件管理器
  • 在事件详情弹窗中点击 📍定位 按钮,将事件固定在事件管理器中
  • 编辑:点击事件(在管理器或详情弹窗)中的 ✏️ 编辑 按钮,修改信息后保存
  • 删除:点击事件(在管理器)中的 🗑️ 删除 按钮

Event Management 事件管理界面.

自定义设置

display

在概览的顶部,有多个显示选项:

  • 显示/隐藏节日、生日、自定义事件
  • 切换到年度一览(推荐)、经典日历或自定义视图
  • 仅限列表视图:
  • 限制列表高度
  • 隐藏无事件的日期

更多设置可以在插件设置中查看。

settings

安装方法

手动安装

  1. 最新发布页 下载 yearly-glance.zip
  2. 解压到你的 Obsidian 仓库的插件文件夹内: <仓库路径>/.obsidian/plugins/yearly-glance/
  3. 重启 Obsidian 并在设置-社区插件中启用

BRAT 安装(推荐体验新功能)

  1. 安装 BRAT 插件
  2. 在 BRAT 设置中“添加 Beta 插件”,输入 Moyf/yearly-glance
  3. 启用插件

开发与贡献

  1. 克隆本仓库
  2. 确保 NodeJS 版本 ≥ 18 (node --version)
  3. 安装依赖:npm iyarn
  4. 开启开发模式:npm run dev
  5. 构建插件:npm run build
  6. 构建并复制到你的 Obsidian 仓库(需要 .env 文件,包含 VAULT_PATH=/path/to/your/vault):npm run build:local
  7. 更新版本和更新清单:npm run version
  8. 发布新版本:npm run release

支持与反馈

许可证

MIT License,详见 LICENSE

星标历史

Star History Chart

如果喜欢本插件,可以加个⭐️星星表示支持!

Extension points exported contracts — how you extend this code

EventFormData (Interface)
* 事件表单数据接口 * 继承 BaseEvent 的所有基础属性,并包含三种事件类型的特有属性
src/components/EventForm/EventForm.tsx
UUIDOptions (Interface)
* UUID 选项 * prefix: UUID 前缀,如 'table-' * length: UUID 长度(不包括前缀) * charset: 自定义字符集 * separator: 前缀和 UUID 之间的分隔符 * ti
src/utils/uuid.ts
IBaseSettingsItem (Interface)
(no doc)
src/i18n/types.ts
EmojiEntry (Interface)
(no doc)
src/data/emojiData.ts
HeaderUpdatableLeaf (Interface)
(no doc)
src/views/YearlyGlanceView.ts
StandardDate (Interface)
(no doc)
src/type/Date.ts
EventSearchPayload (Interface)
(no doc)
src/hooks/useEventBus.ts
ColorSelectorProps (Interface)
* 颜色选择器组件 * 1. 支持默认颜色显示 * 2. 仅在颜色被修改后显示重置按钮 * 3. 可自定义标签和提示文本 * 4. 可控制默认颜色的提交行为 * value: 当前所选颜色 * defaultColor: 默认颜
src/components/Base/ColorSelector.tsx

Core symbols most depended-on inside this repo

t
called by 454
src/i18n/i18n.ts
handleUpdateConfig
called by 35
src/components/Settings/ViewSettings.tsx
toString
called by 25
src/type/BasesTypes.ts
getConfig
called by 23
src/main.ts
handleFieldChange
called by 15
src/components/EventForm/EventForm.tsx
parse
called by 13
src/utils/isoUtils.ts
expandEventByDuration
called by 12
src/utils/expandEventByDuration.ts
hexToRgb
called by 12
src/hooks/useYearlyCalendar.ts

Shape

Function 244
Method 197
Interface 78
Class 52
Enum 1

Languages

TypeScript100%

Modules by API surface

src/main.ts37 symbols
src/components/YearlyCalendar/YearlyCalendar.tsx26 symbols
src/service/DailyNoteService.ts21 symbols
src/components/DataPort/DataExport.tsx18 symbols
src/views/YearlyGlanceBasesView.tsx17 symbols
src/components/EventManager/EventManager.tsx17 symbols
src/service/DateParseService.ts16 symbols
src/components/Settings/PresetEventTypeSettings.tsx16 symbols
src/views/GlanceManagerView.tsx13 symbols
src/utils/isoUtils.ts13 symbols
src/components/Settings/PresetColorSettings.tsx12 symbols
src/components/DataPort/DataImport.tsx12 symbols

For agents

$ claude mcp add yearly-glance \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page