Documentation
By Amr Abdel Eissa
User documentation for the Zer0-Mistakes Jekyll theme - installation, features, customization, and deployment guides.
Estimated reading time: 46 minutes
Table of Contents
Zer0-Mistakes Documentation
Welcome to the Zer0-Mistakes Jekyll theme documentation. This section contains user-facing guides for installing, configuring, and customizing the theme.
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
Collection Index - docs
Documentation
Zer0-Mistakes Documentation
Google Analytics
Google Analytics
Google Tag Manager
Google Tag Manager
Analytics
Analytics
Bootstrap Integration
Bootstrap 5.3.3 Integration
Include Components
Include Components
Customization
Customization
Layouts
Layouts
Navigation
Navigation
Styles
Styles
Custom Domain Setup
Custom Domain Setup
Deploy to GitHub Pages
Deploy to GitHub Pages
Deployment
Deployment
Deploy to Netlify
Deploy to Netlify
CI/CD Pipeline
CI/CD Pipeline
Dependency Updates
Dependency Updates
Documentation
Documentation Architecture
Development
Development Documentation
Product Requirements Document
Product Requirements Document
Release Management
Release Management
Scripts
Shell Script Automation Library
Security Scanning
Security Scanning
Testing
Testing Guide
Version Bump Workflow
Version Bump Workflow
Docker
Docker Development
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
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
PostHog Analytics
PostHog Analytics
AI Preview Image Generator
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
Theme Version Display Plugin
Theme Version Display Plugin
Table of Contents
Table of Contents
Front Matter
Front Matter
Getting Started
Getting Started
Quick Start Guide
Quick Start Guide
Jekyll Theme Guide
Jekyll Theme Guide
Installation
Installation
Code Highlighting
Code Highlighting
Jekyll Collections
Jekyll Collections
Deploying to Netlify
Deploying to Netlify
Custom Domain
Custom Domain
Jekyll
Jekyll
Jekyll Configuration
Jekyll Configuration
Front Matter
Front Matter
Syntax Highlighting
Syntax Highlighting
Jekyll + Liquid
Jekyll + Liquid
MathJax
MathJax
Performance Optimization
Performance Optimization
Security
Security
Mermaid Native Markdown
Mermaid Native Markdown
Pagination
Pagination
Liquid
Liquid
Ruby 101
Ruby 101
Ruby
Ruby & Bundler
SEO
SEO Features
SEO Meta Tags
SEO Meta Tags
Sitemap Generation
Sitemap Generation
Troubleshooting
Troubleshooting