Skip to main content
Settings
Color Mode
Theme Skin
Background

Appearance preferences are saved in this browser only.

Environment
Current Environment Production

Built with JEKYLL_ENV=production. Changes require deployment.

Quick Links
Theme & Build
Theme
Jekyll v3.10.0
Last Build Jul 24, 16:02
Repository
bamr87/zer0-mistakes
Changelog Docs Jekyll
Admin
Configuration Theme Customizer Navigation Editor Environment Dashboard
Page Location
Page Info
Layout default
Collection docs
Path _docs/obsidian/index.md
URL /docs/obsidian/
Date 2026-07-24
Source Code
View on GitHub Edit in GitHub.dev
Configuration
Site Config _config.yml

Obsidian Vault Integration

Edit Zer0-Mistakes content as an Obsidian vault and have it render identically on GitHub Pages.

Estimated reading time: 1 minute

Improve Edit on GitHub

Table of Contents

Obsidian Vault Integration

The Zer0-Mistakes repository is a fully-functional Obsidian vault. Open the repo root (or any subfolder containing notes) as a vault and every Markdown file is editable with Obsidian’s wiki-links, embeds, callouts, graph view, and backlinks. The same files render on GitHub Pages with the equivalent presentation — no duplication, no separate sync step.

In this section

Page What it covers
Getting started Open the repo as a vault, recommended plugins, frontmatter rules.
Syntax reference Every Obsidian feature and how it renders on the site.
Graph view Interactive force-directed map of every page and wiki-link.
Authoring workflow Daily note → commit → publish loop.
Troubleshooting Broken links, missing embeds, conflicts.

How it works

The integration has two pieces:

  1. Server-side data emission. A Liquid template emits assets/data/wiki-index.json at every Jekyll build, listing every collection document and standalone page (title, basename, permalink, tags, aliases, excerpt). This works on the default GitHub Pages remote_theme build with no custom plugins required.
  2. Client-side resolver. assets/js/obsidian-wiki-links.js loads the index in the browser and rewrites [[wiki-links]], ![[embeds]], inline #tags, and Obsidian callout blockquotes into Bootstrap-styled HTML. The result is indistinguishable from server-rendered output for readers, and lets the integration ship on plain GH Pages without a custom CI workflow.

For users who self-build with vanilla Jekyll (no github-pages gem), an opt-in Ruby plugin (_plugins/obsidian_links.rb) performs the same transformations server-side for slightly better SEO. See the syntax reference for the complete feature matrix.

See also

  • [[Getting Started with the Obsidian Vault]]
  • [[Obsidian Syntax Reference]]
  • [[Obsidian Graph View]]
  • [[Obsidian Authoring Workflow]]
  • [[Obsidian Integration Troubleshooting]]
  • [[front-matter]]
  • [[Installation]]
  • Remote-Theme Consumer Checklist docs
    What remote_theme does not deliver on GitHub Pages, and the files and config every Zer0-Mistakes consumer must add to avoid silent breakage.
  • Getting Started docs
    Quick start guides and initial setup for the Zer0-Mistakes Jekyll theme.
  • Documentation docs
    User documentation for the Zer0-Mistakes Jekyll theme - installation, features, customization, and deployment guides.
  • Obsidian Authoring Workflow docs
    From an empty Obsidian note to a published page on GitHub Pages — the daily loop.
  • Getting Started with the Obsidian Vault docs
    Open the Zer0-Mistakes repo as an Obsidian vault, install recommended plugins, and learn the frontmatter conventions.
  • Obsidian Graph View docs
    Interactive force-directed map of every wiki-link in the site, mirroring Obsidian's local graph.
  • Obsidian Resolver — Performance & Caching docs
    How the zer0-mistakes Obsidian wiki-link resolver caches the page-URL index and short-circuits rewrites for measurable build-time improvements on large vaults.
  • Obsidian Syntax Reference docs
    Every Obsidian-flavoured Markdown feature supported by the Zer0-Mistakes theme and how it renders on GitHub Pages.