Skip to content

0.0.2

Choose a tag to compare

View all tags
@github-actions github-actions released this 29 Jul 21:43
0.0.2
ea07884

HTML Shelf 0.0.2

This is the first complete public release of HTML Shelf, an Obsidian plugin for browsing and reading HTML files directly inside your vault on desktop and mobile.

Obsidian Mobile does not normally expose HTML files in its file explorer. HTML Shelf provides a dedicated, searchable library and an in-app reader so generated plans, reports, documentation, and other HTML pages remain available alongside your notes.

Highlights

  • Browse .html files from a dedicated shelf, grouped by vault folder.
  • Optionally include .htm files.
  • Search the shelf instantly by page title or path.
  • Open HTML pages in Obsidian tabs instead of the external browser.
  • Render safely on Obsidian Desktop, Android, and iOS.
  • Follow relative links between HTML pages and jump to in-page anchors.
  • Navigate back through page history with scroll-position restoration.
  • Return index.html links to the shelf instead of listing index pages as entries.
  • Refresh automatically when HTML files or shelf manifests are added, changed, renamed, or deleted.
  • Restrict discovery with include-folder and exclude-folder settings.
  • Add curated titles and sections with optional per-folder html-shelf.json manifests.
  • Follow Obsidian light and dark themes.

Security model

HTML Shelf removes scripts, inline event handlers, embedded executable content, unsafe URLs, remote stylesheets, and CSS @import rules before rendering. Desktop and Android use a sandboxed iframe without script permission; iOS uses an isolated Shadow DOM renderer.

Remote images and resources referenced through inline CSS may still load, and local linked CSS files are loaded without rewriting their contents. Only open HTML files you trust.

Compatibility

  • Requires Obsidian 1.12.0 or newer.
  • Supports desktop and mobile installations.
  • Tested on Obsidian Desktop, Android, and iOS.

Installation

Open Settings → Community plugins in Obsidian, select Browse, search for HTML Shelf, then select Install and Enable.

For manual installation, copy main.js, manifest.json, and styles.css from this release into .obsidian/plugins/html-shelf/ inside a vault, reload Obsidian, and enable HTML Shelf under Settings → Community plugins.

Release quality

  • Passed the full typecheck, lint, test, coverage, and production-build gate.
  • Includes official Obsidian plugin lint checks.
  • Resolves the findings from the initial Obsidian community validator review.
  • Publishes signed GitHub build-provenance attestations for every release asset.
  • Includes Renovate configuration for ongoing dependency maintenance.

Changes since 0.0.1

  • Removed runtime-created style elements while preserving theme handling, mobile bottom clearance, and iOS rendering.
  • Replaced workspace APIs that were newer than the declared compatibility baseline.
  • Added searchable settings definitions for Obsidian 1.13 and newer while retaining compatibility with Obsidian 1.12.
  • Replaced the deprecated builtin-modules build dependency.

View the full comparison

Assets 5
Loading