Zhushroom Calendar

by qinnqiu
5
4
3
2
1
Score: 50/100

Description

Obsidian plugin: a full calendar in a tab (week/month/year, timetable, DDL countdown, habits, mood) writing Markdown into your vault.

Reviews

No reviews yet.

Stats

0
stars
50
downloads
0
forks
6
days
6
days
6
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
15
commits

Latest Version

6 days ago

Changelog

Changelog

1.0.4

  • Week view is now a time grid: an hour scale on the left, events placed at their start time, short events kept at a readable minimum height and pushed down so they never overlap, plus a "now" line in today's column that follows the clock.
  • Week view fits the window height: the hour height is computed on load and on resize (14–56 px) instead of always scrolling.
  • New Show time axis in week view switch (Settings → Display). Turning it off returns the week grid to a plain seven-column list; the automatic time-range option is disabled while the axis is off.
  • Clicking an empty half-hour slot opens the add dialog with that hour pre-filled (start HH:00, end HH+1:00), and the end date defaults to the same day.
  • Multi-day events in the all-day row no longer overlap their checkbox; each chip shows a 跨天 / 续 marker, with a solid left border on the first day and a dashed one on the following days.
  • The page title moved into the top bar; the header row is shorter and the view controls stay on one line.
  • Connection dot: green when a vault is connected, neutral grey otherwise, no halo.
  • Sync status now reflects what is actually in the vault: the month files are read back and compared before saying whether Obsidian is in sync, instead of assuming it is not.
  • Startup shows a single "connected" message instead of two.

1.0.3

  • New Data storage setting (Settings → Data): keep everything in the browser, or connect an Obsidian vault folder so the calendar writes its Markdown notes into that vault. The same choice works in the bundled web build, not only inside Obsidian.
  • Connecting a vault folder runs a write test first and remembers the folder, so the next launch reconnects without picking it again when the browser keeps the permission.
  • Status in the top bar now follows the chosen storage: Obsidian · <vault> when connected, Data kept in this browser otherwise.
  • Fixed: the general settings tab (nickname, page title, DDL message) is shown again after the settings panes were reorganised.
  • Fixed: clicking the folder button inside Obsidian explains that the plugin writes to the vault directly instead of raising a directory-picker error.

1.0.2

  • Bundle rebuilt from the current page; no behaviour change for existing users.

1.0.1

  • README rewritten with installation and usage instructions in English.
  • Release assets now carry GitHub build provenance attestations.

1.0.0

  • First release: week, month and year views, timetable, DDL countdown, habit tracking, daily mood and daily review, stored as Markdown in the vault.

README file from

Github

Zhushroom Calendar(猪事顺利)

A complete calendar inside an Obsidian tab: week, month and year views, timetable, DDL countdown, habit tracking, daily mood and daily review. Everything is stored as Markdown notes in your vault, so it syncs with the rest of your notes.

The calendar is a single-file page bundled with the plugin. Nothing is downloaded after installation.

Zhushroom Calendar inside Obsidian

Installation

From the community directory:

  1. Open Settings → Community plugins → Browse
  2. Search for Zhushroom Calendar
  3. Install, then enable it

Manually, without the directory:

  1. Download main.js and manifest.json from the latest GitHub release
  2. Create the folder <your vault>/.obsidian/plugins/zhushroom-calendar/
  3. Put both files in that folder
  4. Reload Obsidian, then enable Zhushroom Calendar in Settings → Community plugins

Desktop only: the calendar is rendered in an iframe, so the plugin is not available on mobile.

Usage

  1. Click the pig icon in the left ribbon (or run Zhushroom Calendar: Open calendar from the command palette) to open the calendar in a tab
  2. The first launch shows a three-step wizard: your name, whether to seed sample events, and where data should live
  3. Switch between week, month and year views, the timetable, DDL countdown, habits and daily mood from the left sidebar
  4. Events are created with the Add event button in the lower right corner; clicking a day header adds an event to that day

Everything the plugin writes — events, moods, habits, daily reviews — lands in the 日程 folder and stays readable as plain Markdown, so you can edit the notes by hand at any time.

Settings

Setting Description
Page source Bundled page (default), or a single-file HTML page stored in your vault
Page file path Only used with "vault file", defaults to 猪事顺利.html
Data folder Defaults to 日程; events, moods, habits and reviews are written here
Ribbon icon Pig or mushroom

Where the data lives

日程/
├── 01-每日日程/      # daily events
├── 02-总结报告/      # daily review
├── 07-习惯打卡/      # habits
├── 08-文艺审美/      # daily mood
└── 09-项目追踪/      # project notes

The plugin only reads and writes inside that folder; other notes in your vault are never touched.

Network and privacy

  • The plugin makes no network requests: page, icons and styles are bundled into main.js, and no code is loaded remotely
  • The 学在浙大 (university timetable) sync and DingTalk push entries that exist in the original page are hidden in this build, and the sync functions return early, so nothing fires automatically
  • Data is written to your vault as Markdown only — no upload, no telemetry, no online validation

Limitations

  • Desktop only: the page is rendered in an iframe, which requires the desktop app
  • No 学在浙大 (ZJU course site) sync; that part is a separate local helper and is not part of this plugin
  • The page also keeps a copy of its data in browser localStorage; back up with Settings → Data → Export before switching machines

Development

node tools/build.js <single-file page path>   # inline the page into main.js
node --check main.js                          # syntax check
node test/harness.js                          # smoke test in a fake Obsidian environment
node tools/check-manifest.js                  # manifest compliance check
node tools/check-listing.js                   # review and listing status in the community directory

src/main.js is the plugin source template, main.js is the build artifact (committed so Obsidian can download it directly).

See CONTRIBUTING.md for the workflow.

License

MIT


中文说明

在 Obsidian 标签页里打开完整日历:周 / 月 / 年视图、课程表、DDL 倒计时、习惯打卡、每日心情与每日复盘,数据以 Markdown 写进库内 日程/ 目录。

  • 安装:设置 → 第三方插件 → 浏览 → 搜索 Zhushroom Calendar;或手动把 main.js、manifest.json 放进 <库>/.obsidian/plugins/zhushroom-calendar/
  • 使用:点左侧小猪图标,或命令面板「打开猪事顺利」;首次打开有配置向导
  • 仅桌面端;不含学在浙大同步;插件不联网