Documentation
User documentation for the Zer0-Mistakes Jekyll theme - installation, features, customization, and deployment guides.
Zer0-Mistakes Documentation
Welcome to the Zer0-Mistakes Jekyll theme documentation. This section contains user-facing guides for installing, configuring, and customizing the theme.
Two-tier documentation system: This site (
/docs/) contains user guides — how to use the theme. For contributor and maintainer references (architecture, release automation, system internals), see thedocs/directory in the repository.
Getting Started
New to Zer0-Mistakes? Start here:
| Guide | Description | Time |
|---|---|---|
| Installation | Set up the theme with Docker or Ruby | 10 min |
| Quick Start | Multiple installation paths | 15 min |
| Theme Guide | Complete setup and customization | 30 min |
Core Documentation
Configuration
- Front Matter — Page metadata and options
- Jekyll Configuration — Site settings and options
Features
Enable powerful features for your site:
| Feature | Description | Front Matter |
|---|---|---|
| Mermaid Diagrams | Flowcharts, sequence diagrams | mermaid: true |
| MathJax Math | Mathematical equations | mathjax: true |
| Giscus Comments | GitHub Discussions comments | comments: true |
| PostHog Analytics | Privacy-first analytics | (site-wide) |
| Keyboard Navigation | Accessibility shortcuts | (always on) |
Customization
Make the theme your own:
- Layouts — Page templates
- Styles — CSS customization
- Navigation — Menus and sidebars
Deployment
Publish your site:
- GitHub Pages — Free hosting with GitHub
- Netlify — Advanced hosting features
- Custom Domain — Use your own domain
Technology Guides
Reference documentation for the underlying technologies:
- Jekyll — Static site generator
- Bootstrap — CSS framework
- Liquid — Template language
- Ruby — Programming language
- Docker — Development environment
Troubleshooting
Having issues? Check the Troubleshooting Guide.
For Developers
Looking to contribute to the theme? See the developer documentation in the repository’s docs/ directory for:
- Architecture documentation
- Development setup
- Testing guides
- Release process
Quick Navigation
- Installation — Get started
- Features — Enable features
- Customization — Make it yours
- Deployment — Go live
Last Updated: January 2026
See also
- Installation
- Features
- Customization
- Deployment
- Obsidian Vault Integration
- Jekyll
- Docker
- Bootstrap Integration
Collection Index - docs
Documentation
Zer0-Mistakes Documentation
Zer0-Mistakes Product Requirements Document
Product Requirements Document
Schema
SCHEMA — _docs
Schema
SCHEMA — analytics
Google Analytics
Google Analytics
Google Tag Manager
Google Tag Manager
Analytics
Analytics
Schema
SCHEMA — bootstrap
Bootstrap 5 Integration in Zer0-Mistakes
Bootstrap 5.3.3 Integration
Schema
SCHEMA — customization
Author Profiles and About-the-Author Bylines
The theme ships a single, layered author system so every collection — posts, docs, notes, and any you add — presents authors consistently: a linked byline wi...
Include Components
Include Components
Customization
Customization
Layouts
Layouts
Navigation
Navigation
Styles
Styles
Schema
SCHEMA — deployment
Safe-Mode Build Overlay (Building Outside GitHub Pages)
Safe-Mode Build Overlay
Custom Domain Setup
Custom Domain Setup
Deploy to GitHub Pages
Deploy to GitHub Pages
Deployment
Deployment
Deploy to Netlify
Deploy to Netlify
Remote-Theme Consumer Checklist
Remote-Theme Consumer Checklist
Schema
SCHEMA — development
AGENTS.md — Cross-Tool AI Agent Entry Point
AGENTS.md — Cross-Tool AI Agent Entry Point
CI/CD Pipeline
CI/CD Pipeline
Dependency Updates
Dependency Updates
DevContainer Configuration for Codespaces
DevContainer Configuration
Local Docker Publishing Pipeline
Local Docker Publishing Pipeline
Documentation
Documentation Architecture
Config-Driven Frontmatter Validation
Config-Driven Frontmatter Validation
Development
Contributing to Zer0-Mistakes
Release Management
Release Management
Scripts
Shell Script Automation Library
Security Scanning
Security Scanning
Testing
Testing
Vendor assets
Vendor assets (local bundles)
Version Bump Workflow
Version Bump Workflow
Schema
SCHEMA — docker
Docker
Docker Development
Schema
SCHEMA — features
Admin Layout & Configuration Dashboards
Admin Layout & Configuration Dashboards
AI Chat Assistant (Claude + GitHub)
AI Chat Assistant
Auto-hide Navigation
Auto-hide Navigation
Back to Top Button
Back to Top Button
Breadcrumbs Navigation
Breadcrumbs Navigation
Code Copy Button
Code Copy Button
Dark/Light Mode Toggle
Dark/Light Mode Toggle
Cookie Consent Management
Cookie Consent Management
GitHub Copilot Integration
GitHub Copilot Integration
Dynamic Collection-Based Navigation
Dynamic Collection-Based Navigation
Giscus Comments
Giscus Comments
Features
Features
Jupyter Notebook Integration
Jupyter Notebook Integration
Keyboard Navigation
Keyboard Navigation
MathJax Math
MathJax Math
Mermaid Diagrams
Mermaid Diagrams
Mobile TOC Floating Action Button
Mobile TOC Floating Action Button
ES6 Modular Navigation Architecture
ES6 Modular Navigation Architecture
Particles Background
Particles Background
PostHog Analytics
PostHog Analytics
AI Preview Image Generator for Jekyll Posts
AI Preview Image Generator
Sidebar Navigation System
Enhanced Sidebar Navigation System
Site Search
Site Search
Skip-to-Content Accessibility Link
Skip-to-Content Accessibility Link
Smart 404 & Site Configuration Detection
Smart 404 & Site Configuration Detection
Statistics Dashboard
Statistics Dashboard
Theme Version Display Plugin
Theme Version Display Plugin
Table of Contents
Table of Contents
Vendored Bootstrap & Icon Assets
Vendored Bootstrap & Icon Assets
Front Matter
Front Matter
Schema
SCHEMA — getting-started
Getting Started
Getting Started
Quick Start Guide
Quick Start Guide
Jekyll Theme Guide: Setup, Customize, Deploy
Jekyll Theme Guide
Installation
Installation
Schema
SCHEMA — jekyll
Code Highlighting
Code Highlighting
Jekyll Collections
Jekyll Collections
Jekyll
Jekyll
Pagination
Pagination
Schema
SCHEMA — liquid
Liquid
Liquid
Schema
SCHEMA — obsidian
Obsidian Authoring Workflow
Obsidian Authoring Workflow
Getting Started with the Obsidian Vault
Getting Started with the Obsidian Vault
Graph View
Graph View
Obsidian Vault Integration
Obsidian Vault Integration
Obsidian Resolver — Performance & Caching
Obsidian Resolver — Performance & Caching
Obsidian Syntax Reference
Obsidian Syntax Reference
Obsidian Integration Troubleshooting
Obsidian Integration Troubleshooting
Schema
SCHEMA — quickstart
Bare-Minimum Remote-Theme Starter
Bare-Minimum Remote-Theme Starter
Fork and Deploy to GitHub Pages
Fork & Deploy to GitHub Pages
Zer0-Mistakes Quickstart Guides
Quickstart Guides
Ruby 101
Ruby 101
Schema
SCHEMA — ruby
Ruby
Ruby & Bundler
Schema
SCHEMA — seo
AIEO — AI Engine Optimization
AIEO — AI Engine Optimization
Jekyll SEO Features: Meta Tags, Sitemaps & Schema
SEO Features
SEO Meta Tags
SEO Meta Tags
Sitemap Generation
Sitemap Generation
Troubleshooting
Troubleshooting