Home Pages

by jepicaju862-lab
5
4
3
2
1
Score: 26/100

Description

The Home Pages plugin turns the workspace into a modular dashboard built on a responsive 12 column grid. It provides configurable widgets for recent notes, quick access, countdowns, Pomodoro sessions, habits, tasks, vault statistics, note embeds, feeds and other information. Cards can be dragged, resized, duplicated or removed, while separate pages support distinct layouts and tab reordering. Dashboard layouts can be imported or exported as JSON. A host API lets other plugins register widgets and views, and JavaScript files in a chosen vault folder can define custom widgets with automatic reload after edits. Layouts, widget state and settings stay in local data without telemetry. Desktop and mobile are supported, with narrow screens adapting the grid for touch controls. The plugin requires Obsidian 1.7.2 or later.

Reviews

No reviews yet.

Stats

74
stars
4,060
downloads
6
forks
49
days
47
days
49
days
6
total PRs
2
open PRs
4
closed PRs
0
merged PRs
5
total issues
5
open issues
0
closed issues
15
commits

README file from

Github

English 简体中文

Home Pages for Obsidian

A modern, modular, and responsive homepage dashboard plugin for Obsidian. Built on a flexible 12-column adaptive grid, it empowers you to customize your workspace with draggable, resizable, and individually configurable widgets. Support multiple pages and third-party plugin integrations.

[!NOTE] Local-First & Privacy Assured: Home Pages operates entirely within your local Obsidian vault. Layouts, states, and settings are persisted locally in data.json without any background analytics, telemetry, or hidden network tracking.


🌟 Features

🧩 Rich Built-in Dashboard Widgets

Home Pages comes with 12+ built-in productivity widgets that can be freely combined and configured:

Widget Description Key Configurations
Welcome Banner Greeting by time of day, custom nickname, live clock (optional seconds), weather forecast, vault stats, countdown badge, and customizable background image. Weather provider (CMA Station / Open-Meteo / QWeather), city/district selection, background mask, field toggles, vault founding date, target date.
Recent Notes Fast access to recently modified or newly created notes with folder paths. Note count limit, include/exclude folders, sort order, display folder option.
Quick Access Pinned notes, folders, or attachments displayed as interactive icon tiles. Note path autocomplete, display name, Lucide icon picker, custom order, column count.
Countdown & Anniversaries Accurate day count tracking remaining days to goals or elapsed days from anniversaries. Target date, counting direction (past / future), description and subtitle.
Pomodoro Clock Focus, short break, and long break cycle timer with progress ring, task note, and daily/weekly completion statistics. Timers persist across note switches and restarts. Stage durations, long break frequency, auto-start breaks, sound alerts, system notifications.
Daily Quote Display inspiring quotes from a dedicated note (one per line) or custom quote list. Source note path, daily rotation vs. random, custom quote pool.
Habit Tracker Today's check-in checklist combined with a GitHub-style activity heatmap (week / month / year), plus the current streak. Habit items list, storage mode (local plugin data or Daily Note task block sync).
Task Kanban Scans - [ ] markdown tasks and arranges them across Todo [ ], Doing [/], and Done [x] columns. Supports drag-and-drop status changes and inline task creation. Source file or folder, default inbox file, column headers, hide completed toggle.
Vault Statistics Overview metrics including notes count, tags, word count, attachments, folders, vault age, created today, and modified this week. Metric items toggle, grid column layout, exclude folders.
On This Day Surfaces notes created or written on this day across past years. Item count limit, date property key, filename date fallback, ctime fallback.
Note Embed Render any note or specific heading section directly within your dashboard. Note path, section heading, hide frontmatter toggle.
Integrated Feed (Optional) Aggregated information stream combining duowei table insights, annotation inbox, and synced messages. Source toggles, table scope, date fields, message sources.
Tasks & Schedule (Duowei Table) Scans multidimensional tables (.duowei), surfaces overdue, today, upcoming, and recent updates with direct row navigation. Scan scope, exclude tables, date field mappings, section day limits.
WeChat Inbox Aggregates WeChat sync messages with text, audio transcription, and image thumbnails. Data source, unorganized filter, days range, type filters.
Annotations & Review Connects to Mobile Ink Annotation Pro to show inbox annotations, daily reviews, and collections. Card statistics, thumbnail preview, one-click jump to annotation center.
Media & RSS Subscriptions Surfaces articles from mainstream sources and personal custom RSS / OPML feeds. Supports Follow exports, nested categories, podcast/video detection, and offline Markdown clipping. Channel nav style, default channel, OPML import/export, category organization, clipping folder.

📐 Responsive 12-Column Layout

  • 12-Column Adaptive Grid: Automatically reflows and scales proportionately based on viewport width, providing a native visual layout on both desktop ultrawide monitors and mobile devices.
  • WYSIWYG Layout Editing:
    • Click Edit Layout in the header to enter arrangement mode.
    • Drag cards with a mouse, or drag their title/grip on touchscreens. Insertion markers support rows, columns, and gaps; dragging near the view edge scrolls automatically. Press Esc to cancel.
    • Drag the corner handle to resize; width snaps to columns and height to rows, with a live size badge (height only on narrow screens, Esc cancels). Footer buttons and arrow keys on the focused handle step the size too. Edit mode shows 12 column guides.
    • Easily move forward, move backward, duplicate, or delete any widget.
  • Multi-Page Management:
    • Click + at the end of the tab bar at any time to create distinct pages (e.g., "Work Dashboard", "Life Log", "Project Hub").
    • Drag page tabs to reorder in edit mode. Right-click tabs to rename, move left/right, or delete pages.
  • JSON Import & Export: One-click copy and paste of complete dashboard layouts for easy backup and cross-vault migration.

🔌 Host API for Plugin Developers

Home Pages exposes a lightweight host API allowing other Obsidian plugins to register custom widgets and views into the homepage framework:

// Retrieve the API instance when Home Pages is loaded (or listen to "home-pages:ready")
const api = app.plugins.plugins["home-pages"]?.api;

// 1. Register a new widget type
const unregister = api.registerWidget(myWidgetDefinition, "my-plugin-id");

// 2. Programmatically pin a widget to the current homepage
api.pinWidget("my-widget-kind", { ref: "note-path" }, {
  title: "My Pinned View",
  w: 6,
  h: 4,
  provider: "my-plugin-id"
});

// 3. Trigger a dashboard redraw when underlying data changes
api.refresh("my-widget-kind");

// 4. Utilize consistent UI rendering helpers
api.ui.renderKpi(containerEl, { label: "Completed", value: 12 });
api.ui.renderEmpty(containerEl, { message: "No data available" });

Integration Example: Duowei Table (duowei-table-pro ≥ 1.4.0) registers duowei-view via the Host API. Users can right-click any table view tab and select "Pin to Homepage" to display live calendars, kanban boards, and progress timelines on their homepage.


🧩 User-Defined Custom Widgets (Folder-based & Hot-Reload)

Users can build custom widgets directly in JavaScript without creating separate plugins:

  1. In plugin settings, navigate to "Custom Widgets".
  2. Set the "Custom Widgets Folder" (e.g. _scripts/home-pages/), or click "📄 Create Demo Widget Template" to auto-generate demo-widget.js.
  3. Create or edit .js files exporting a standard widget definition:
    module.exports = {
      kind: "user-clock",
      name: "Custom Clock",
      description: "Real-time clock widget",
      icon: "clock",
      accent: "#6366f1",
      defaultSize: { w: 4, h: 3 },
      defaultConfig: () => ({ greeting: "Hello" }),
      render(body, ctx) {
        body.empty();
        const el = body.createDiv();
        el.setText(`${ctx.config.greeting} · ${new Date().toLocaleTimeString()}`);
        ctx.registerInterval(() => {
          el.setText(`${ctx.config.greeting} · ${new Date().toLocaleTimeString()}`);
        }, 1000);
      }
    };
    
  4. Save and it appears: The first time a new script loads, its widget is added to the current page (once per widget; editing a script after you removed its card does not add it back; turn off with Add new custom widgets automatically).
  5. Live Hot-Reload: Save modifications to your .js file from Obsidian or an external editor like VS Code, and homepage cards will automatically reload and re-render instantly!

📥 Installation

Once available in the official Obsidian Community Plugins directory:

  1. In Obsidian, go to Settings → Community plugins.
  2. Turn off Restricted mode and click Browse.
  3. Search for Home Pages.
  4. Click Install, then click Enable.

Method 2: Manual Installation

  1. Download the latest release assets from the GitHub Releases page:
    • main.js
    • manifest.json
    • styles.css
  2. Locate or create your plugin folder inside your vault:
    <vault>/.obsidian/plugins/home-pages/
    
  3. Copy the downloaded files into that directory.
  4. Reload Obsidian and enable Home Pages in Settings → Community plugins.

🖊️ Usage

  1. Opening Home Pages:
    • Click the homepage icon on the left ribbon.
    • Or press Ctrl/Cmd + P and execute the command Home Pages: Open Homepage.
  2. Customizing Layout & Widgets:
    • Click Edit Layout in the top-right corner of the view.
    • Click Add Widget at the top to select and insert any widget.
    • Click the Gear icon on any card header to customize its parameters (weather city, habit list, stats filters, etc.).
  3. Global Settings:
    • Navigate to Obsidian Settings → Home Pages.
    • Configure auto-open on startup, default row height (px), grid gap, maximum width, and manage pages.

⚙️ Settings Reference

Setting Description Default
Open on startup Automatically open homepage when Obsidian launches On
Open in new tab Open homepage in a new tab instead of replacing active tab On
Row height Unit height for grid rows in pixels (24px - 96px) 40px
Grid gap Spacing between widget cards in pixels (4px - 40px) 16px
Max content width Max width constraint (0 fills window width) 1400px
Always show page tabs Keep page tabs visible even with single page On (new installs)
Add new custom widgets automatically Put a custom widget on the current page the first time its script loads On
Page management Add, duplicate, rename, or remove homepage layouts Default page
Import / Export Copy or paste full dashboard layouts in JSON format -

🔒 Data & Privacy

  • 100% Local Storage: All dashboard configurations, layout JSONs, pomodoro records, and habits are stored locally in data.json.
  • Zero Telemetry: The plugin does not collect usage analytics, telemetry, or user metrics.
  • Network Requests: Weather queries are only initiated when a weather-enabled banner is rendered:
    • CMA Station requests public endpoints without keys.
    • Open-Meteo and QWeather only connect when explicitly selected and configured.
  • Bundle Integrity: A fail-closed security gate (scripts/verify-bundle.mjs) ensures the distributed bundle contains no dynamic script generation, eval(), or new Function().

❓ FAQ

Will layout break on mobile devices?

No. Home Pages provides responsive adaptive rules for small screens. On narrow viewports, the grid seamlessly collapses into full-width or compact columns optimized for touch interaction.

Does the Pomodoro timer keep running if I switch notes or restart Obsidian?

Yes. The timer state and start timestamp are persisted in plugin memory and data. Switching views or restarting Obsidian restores the timer seamlessly.

How do I restore the default initial layout?

In Settings → Home Pages → Pages, click + New Default Page at any time to generate a clean instance of the default layout.


🧑‍💻 Development

Contributions and pull requests are welcome!

# 1. Install dependencies
npm install

# 2. Start dev build with watch mode
npm run dev

# 3. Lint source code
npm run lint

# 4. Production build with security audit
npm run build

📋 Release Notes

For detailed changelogs and version release histories, see RELEASE_NOTES.md (or RELEASE_NOTES.zh-CN.md).


🤝 Support & Feedback

  • Bug Reports & Feature Requests — this repository's issue tracker. Please include your Obsidian version, operating system, and reproduction steps whenever possible.
  • Questions & Discussion — QQ group 1094620986. The group communicates primarily in Simplified Chinese.
  • Email — [email protected]. Use email for private reproduction files or inquiries.
  • Official Website — peyote.info.

📬 Contact


📄 License

This project is licensed under the GNU General Public License v3.0.

Similar Plugins

info
• Similar plugins are suggested based on the common tags between the plugins.
Sakana Widget
4 years ago by Boninall
Add the Sakana! Widget to your own Obsidian
Editing Toolbar
4 years ago by Cuman
An obsidian toolbar plugin, modified from the Cmenu plugin
Plugin Groups
4 years ago by Mocca101
A plugin that allows you to easily group and manage your other plugins in Obsidian.
Text Wrapper
4 years ago by smx0
Plugin for Obsidian
Custom Classes
4 years ago by Lila Rest
A minimal Obsidian plugin that allows you to add your own HTML classes to chosen Markdown elements directly from your notes.
Unicode Search
4 years ago by BambusControl
Simple Unicode character search for Obsidian.md
Callout Integrator
4 years ago by
A plugin for Obsidian to allow the integration of long blocks of text into callouts.
Emoji Magic
4 years ago by simplgy
Makes it easier to add emojis using an improved keyword search
Natural Language Syntax Highlighting
4 years ago by artisticat
Highlight adjectives, nouns, adverbs, verbs, and conjunctions in Obsidian.md
Widgets
3 years ago by Rafael Veiga
Add cool widgets to your notes or your dashboard in Obsidian
Root Folder Context Menu
3 years ago by mnaoumov
Obsidian Plugin that enables context menu for vault root folder
Beautitab
3 years ago by Andrew McGivery
A plugin for Obsidian.MD that creates a customizable new tab view with beautiful backgrounds, quotes, search, and more.
Canvas Daily Note
3 years ago by Andrew McGivery
A plugin for Obsidian that allows you to add a daily note node to the canvas that will always show todays note.
Better Order List
3 years ago by Boninall
Tag Formatter
3 years ago by snsvrno
Configurable Obsidian plugin that hides parent tags.
Set View Mode per Note
3 years ago by Alex Davies
Use YAML frontmatter to specify a view mode per note.
Metadata Icon
3 years ago by Benature
change metadata entry icon
MantouAI
3 years ago by Morino Pan
MantouAI—— 让Obsidian变身智能助手
Homepage
5 years ago by mirnovov
An Obsidian plugin that opens a specified note, canvas, or workspace on startup, instead of the most recent one.
Daily Note Metrics
2 years ago by Andre-Diamond
Obsidian Plugin that parses Daily Notes and uses data to create charts
Countdown To
a year ago by Gui Cattani
A countdown/progress Obsidian widget using progressbar.js
Simple Banner
a year ago by Sandro Ducceschi
Visually enhance your Obsidian notes with a customizable banner. Supports icons and time/date display.
Simple Columns
a year ago by Josie
An Obsidian plugin that lets you create easily resizable and customizable columns in your notes.
New 3D Graph
a year ago by Aryan Gupta
Visualize your vault in 3D with a powerful, highly customizable, and filterable graph.
Pixel Pets
a year ago by Lucas Jin
Adds cute pixel pets to Obsidian.
Custom Slides
a year ago by David V. Kimball
Customize Obsidian's Slides core plugin's navigation, styles, and behavior.
Startpage
a year ago by kuzzh
A modern startup homepage plugin for Obsidian that provides a beautiful dashboard interface, displaying vault statistics, pinned notes, and recent notes.
Custom Theme Studio
a year ago by @gapmiss
An Obsidian.md plugin to create and tweak custom themes with live CSS editing, element styling, and instant previews. All without leaving Obsidian.
My SVGs
10 months ago by Omar Badawy
An Obsidian plugin that Registers your own SVGs into Obsidian's global icon library for use with other plugins or however you want.
Weather Widget
10 months ago by mr-asa
Weather widget for display in notes, Canvas, and a separate tab.
Synaptic View
8 months ago by Yongmini
Obsidian Plugin : Synaptic View that unifies your dashboards, hub notes, quick-entry notes, periodic notes, web shortcuts, and calendar navigation—enable it as the default new-tab experience or summon it with a command.
Dragger
5 months ago by ariestar
An Obsidian plugin for dragging and rearranging any block.
Commander
5 months ago by jsmorabito
Commander - Obsidian Plugin | Add Commands to every part of Obsidian's user interface
Apex Dashboard
5 months ago by PandoraReads
Stop switching between Obsidian notes. One page. Everything you need. Memo your thoughts, crush your todos, track your projects — and make it look incredible doing it.
基于第二大脑理念的Obsidian工作台,一站式管理笔记、待办、备忘录、项目和你的日常工作流
Journalit
4 months ago by Cursive
Obsidian trading journal with broker sync, trade imports, analytics, prop firm tracking, reviews and rule-based trading workflows.
Sheet Plus
4 months ago by ljcoder
obsidian spreadsheets solutions
Xove Dashboard
3 months ago by ty
Obsidian 个人工作台插件:把任务管理 / 项目管理 / 灵感收集 / 笔记统计 收进一个首页,数据全留在本地的。
ICOR for Life - Connect
3 months ago by Paperless Movement S.L.
Your app.myicor.com account inside your vault: ICOR Journey and Growth Assignment dashboards, knowledge-base search, reflections synced as notes you own, and myICOR context for Claude sessions. Part of the ICOR for Life suite.
Chronobars
2 months ago by Daniel Hidefjäll
Create time-based progress bars in Obsidian
Simple Reminder
2 months ago by Dmitry
Напоминалка
List Callouts Improved
2 months ago by Daniel Yim
Create callouts in lists in Obsidian.
BrainCore LifeOS
2 months ago by 囍樂
BrainCore 侧边栏不仅是一个展示面板,更是你整个 Obsidian 知识库的“核心呼吸机”。它由 6 大模块组成,涵盖了时间感知、极速收集、工作流转、习惯养成与知识内化。一切信息从这里输入,最终也会在这里沉淀。
Projects Plus
2 months ago by Pavel
Projects Plus turns a folder of notes into a managed project: you see all tasks on a kanban board, all events on a calendar, all cards in a gallery — all without export, without cloud, right in your vault.
Mermaid Beauty
2 months ago by theChildinus
Make Mermaid diagrams clearer in Obsidian, with automatic layouts, coordinated colors, and per-diagram controls. Works offline and preserves your source.
Prism
a month ago by floorianmb
Prism: sandboxed, themed, interactive visualizations in Obsidian notes
Note Pulse
a month ago by shovy
Dashboard for your Obsidian vault: note and word trends, writing streak heatmap, task completion, tags and link stats.
Genkan
a month ago by Kenroy Harrison
A dashboard for Obsidian. Can also display notes from Pebble index-01 ring if configured.
Magical Cards
a month ago by FF Barry
Interactive book and film cover cards for Obsidian, with draggable modules and note embeds.
Home Cards
a month ago by ttangents
Give your vault a homepage: a start page or dashboard of note cards from recent notes, properties, tags, links and Bases, with pins, project boards and pages for any folder or tag.
Cool Bases
a month ago by pattgue
Design cool card views for Obsidian Bases.
InventExplorer
22 days ago by solidinvent
Add file and folder icons, colors and text styles to the file explorer. Lucide, Tabler, Boxicons, Phosphor and emoji icons, with regex rules that style many paths at once.