Obsidian Stats logoObsidian Stats

Lighthouse

by benjamincassidy
5
4
3
2
1
Score: 40/100
Install Code

Description

Reviews

No reviews yet.

Stats

3
stars
445
downloads
0
forks
74
days
71
days
74
days
41
total PRs
0
open PRs
1
closed PRs
40
merged PRs
49
total issues
26
open issues
23
closed issues
68
commits

Latest Version

1.3.0
2 months ago

Changelog

This release is mostly under the hood — no new user-facing features, but a round of fixes to keep Lighthouse aligned with Obsidian's latest plugin guidelines and APIs.

⚠️ Minimum Obsidian version raised to 1.12.0

Lighthouse now requires Obsidian 1.12.0 or later (up from 1.4.0), to support the Settings and popout-window APIs used below. If you're on an older Obsidian, update Obsidian before updating this plugin.

Changed

  • Adopted Obsidian's new declarative Settings API on 1.13.0+, with the classic settings-tab rendering kept as an automatic fallback for 1.12.x
  • Destructive actions (like deleting a project) get Obsidian's native destructive button styling on 1.13.0+
  • Internal code now consistently uses Obsidian's activeDocument/ activeWindow, for correctness if you use Obsidian in a popout window
  • Removed unused legacy code left over from an early export-style prototype that was never actually wired into PDF/DOCX export

Fixed

  • Cleaned up remaining CSS issues flagged by Obsidian's plugin review tooling (!important usage, an expensive :has() selector)
  • Fixed leftover template text in the docs site's README
  • Updated dependencies to resolve a couple of moderate security advisories

Full Changelog: https://github.com/benjamincassidy/lighthouse/compare/1.2.0...1.3.0

See all version on GitHub

README file from

Github

Lighthouse

Project-based writing for Obsidian

GitHub release Downloads License: MIT

Documentation · Community Plugin listing · Report an issue

"It was done; it was finished. Yes, she thought, laying down her brush in extreme fatigue, I have had my vision." — Virginia Woolf, To the Lighthouse

Lighthouse brings the focus of a dedicated writing app to Obsidian, inspired by Ulysses but without giving up Obsidian's power and flexibility. One command opens a dedicated Library and Inspector for a project — groups, goals, pacing, and focus, all built on plain markdown files in your vault. No lock-in, no proprietary format.

Screenshots

Features

Writing Workspace

  • The Library — a Ulysses-style Groups & Sheets browser in the left sidebar, replacing Obsidian's file explorer for the duration; drag-and-drop to reorder groups and sheets
  • The Inspector — right-sidebar panel with Overview (goal ring, writing heatmap, streak), Stats (live counts, pacing), and Outline tabs
  • One-command layout — toggle the whole workspace on/off from the ribbon; the native file explorer is restored automatically on exit

Project Management

  • Multiple projects — create and manage independent writing projects, each with its own configuration
  • Groups & Extras — organize a project into nestable Groups with custom icons; a built-in Extras group holds research and notes excluded from word counts
  • Project switcher — fuzzy-search modal to jump between projects instantly

Word Counting

  • Smart hierarchical counts — real-time word counts at file, group, and project levels
  • Per-file and per-group goals — set individual targets on files or groups with inline progress rings
  • Word count goal directions — at least (minimum target) or at most (word limit / trim mode)
  • Status bar count — live word count visible at the bottom of every window
  • Per-file exclusion — tag any note lighthouse-uncounted: true to exclude it from totals without moving it into Extras

Progress & Pacing

  • Deadline tracking — set a target finish date; see words/day needed and days remaining
  • Adaptive daily pace — required daily target recalculates automatically as you write over or under the target
  • Writing activity heatmap — a 13-week calendar of daily output with variable-size circles
  • Writing streak — current streak and personal best; rest days keep the chain alive
  • 7-day rolling average — on-pace / behind-pace indicator against your required daily target
  • Read/speak time — estimated reading time (250 wpm) and speaking time (130 wpm) for the project total

Export & Editing

  • Compile & export — PDF (via Typst), DOCX and EPUB (via Pandoc), or plain Markdown, with built-in style presets and paper sizes
  • Citations — per-project bibliography and CSL citation style, with 10 bundled styles and the ability to download thousands more
  • Split & merge — split a note at the cursor into a new sibling file; merge one note into another from its context menu

Flow Mode

  • Hides sidebars, ribbon, status bar, tabs, breadcrumbs, and navigation
  • Optional typewriter scroll, custom font, line height, and line width settings

Roadmap

  • Manuscript Mode — continuous read-only multi-file view for reading your whole draft as one document
  • Project-wide Outline — cross-file heading tree for navigation, beyond the current per-file Outline tab
  • Dataview integration — enhanced Inspector queries
  • Templater integration — project-aware template variables

Quick Start

  1. Create a project — Command Palette → Lighthouse: Create new project
  2. Open the Writing Workspace — click the compass icon in the ribbon
  3. Add Groups — organize your writing into Groups in the Library; research and notes go in the built-in Extras group
  4. Set a goal (optional) — edit the project and add a word count goal and deadline
  5. Start writing — Lighthouse tracks everything automatically, with live stats in the Inspector

See the Getting Started guide for the full walkthrough.

Installation

Open the Lighthouse listing on the Obsidian Community Plugins website and click Add to Obsidian — this opens Obsidian directly to the install page. See the installation guide for the in-app browse method and manual installation.

Contributing

Contributions are welcome — bug reports, feature suggestions, and pull requests. Open an issue to start a discussion before larger changes.

Support

If you find Lighthouse helpful, consider:

  • Starring the repository
  • Sponsoring on GitHub
  • Reporting bugs and suggesting features
  • Improving documentation

License

MIT License — see LICENSE for details.

Acknowledgments

Built for the Obsidian community.

Sponsors