Configure, author, test, and deploy jekyll-obsidian.

Documentation

The handbook follows the same directory tree you see in any Markdown editor, including Obsidian. Start with Host Integration to publish through GitHub Actions without a local build, or Getting Started to publish the first note.

  • Syntax and Customization cover authoring, themes, Blog, navigation, contacts, Search, Graph, tags, feeds, source actions, and site configuration.
  • Portfolio covers automatic project collections and public GitHub Markdown bodies.
  • Comments covers GitHub Discussions setup, thread identity, privacy, and troubleshooting.
  • Analytics covers optional Cloudflare and Google traffic measurement.
  • Localization covers locale manifests, translation overlays, fallback pages, and SEO behavior.
  • Deployment covers GitHub Pages, base paths, custom domains, canonical metadata, sitemaps, and production checks.
  • Developer Guide covers the contributor toolchain, architecture, and OFM contract.
  • CJK showcase demonstrates mixed-script typography and search.

Search this site

The index loads when search opens.

    Browse

    Context

    Full graph

    Loading graph…

    Local graph

    Loading graph…

    Image