Zero Server Runtime • 100% Client-Side Pipeline • Standalone 4 MB Bundle

100% Static, Single-File Markdown Wiki & Docs Engine

Drop a single standalone index.html alongside your Markdown documents. No Node.js build pipelines, no databases, and zero rebuild commands. Instant client-side compilation with Marked v15, DOMPurify, KaTeX, Prism, Mermaid, and GPU theme switching.

Get Started in 5 Minutes Explore Architecture

$ curl -fsSL https://github.com/Octadira/vertiwiki/releases/latest/download/vertiwiki.html -o index.html

Documentation Hub

Direct Access to Engineering Guides

Explore hands-on quickstarts, architectural blueprints, runbooks, and comprehensive API references.

🚀

Getting Started

Jump into a 5-minute hands-on tutorial with runnable code, quick setups, and minimal configurations.

🏛️

System Architecture

Explore the zero-backend client-side pipeline, state machines, and C4 container topology.

⚙️

Configuration Guide

Discover all runtime schema parameters, layout modes, i18n locales, and branding settings.

🛠️

Operations & Runbooks

Production hosting runbooks for Cloudflare Pages, AWS CloudFront, Vercel, and incident triage.

📖

TypeScript API Catalog

Verbatim typed signatures, parameter tables, plugin hooks, and boundary interfaces.

🔄

Execution Workflows

End-to-end request flow, route dispatch, DOM sanitization, and hydration sequence diagrams.

Technical Architecture

Engineered for Permanence & Speed

Six foundational architectural attributes that eliminate backend complexity and guarantee long-term documentation reliability.

01 / CLIENT-SIDE RUNTIME

Zero Backend & Zero Build Steps

No server pipelines, no Node.js processes, and no rebuild commands upon editing Markdown. Drop index.html in any folder and serve statically.

DOMPurify • Marked v15 • SPA Router

02 / SINGLE-FILE BUNDLE

Standalone Single-File Distribution

Compiled via Vite 6 with vite-plugin-singlefile. Marked v15, DOMPurify, KaTeX, Prism, and Mermaid are all packed into a single 4 MB self-contained bundle.

Zero Node Modules • Air-Gapped Portable

03 / SECURITY BOUNDARY

Defense-in-Depth Trust Boundary

Automated iframe sandboxing enforces allow-presentation while blocking frame-busting exploits. Dangerous schemes (javascript:, vbscript:) are stripped from all anchors.

Strict DOMPurify • Zero-XSS Invariant

04 / AEO & AGENT DISCOVERY

Static Bot Crawl Tree & AEO

Integrated semantic crawl tree allows instant discovery by Googlebot without SSR, combined with dynamic Schema.org TechArticle JSON-LD and standard llms.txt.

AgentDocsSpec • llms.txt • JSON-LD

05 / GPU THEMING ENGINE

Decoupled Themes & 11 Presets

Swaps CSS custom properties on document.documentElement in under 1ms without page reloads. Supports external custom theme JSON files via the themes/ directory.

11 Presets • Obsidian • Editorial • Nord

06 / IN-MEMORY SEARCH

Instant Client-Side Search (ƒK)

Lightning-fast in-memory client search with MiniSearch. Includes fuzzy matching, automatic document tokenization, keyboard shortcuts (ƒK or /), and locale scoping.

MiniSearch • Sub-millisecond • Zero Lag

Lifecycle Architecture

Deterministic 10-Step Rendering Pipeline

How VertiWiki transforms raw Markdown into a sanitized, fully-interactive documentation interface in milliseconds upon navigation.

Route Hash & Query Parsing

Resolves #/path.md or query parameter ?page= for Server Content Negotiation rewrites.

Asynchronous Resource Fetch

Fetches raw Markdown via fetch() with deterministic subfolder resolution and 404 fallback.

YAML Frontmatter Parsing

Extracts metadata headers, document author, custom tags, and per-page theme/layout overrides.

beforeParse Lifecycle Hooks

Processes custom macros including code tabs (::: tabs), expandable details, and badges.

Marked v15 & DOMPurify

Compiles CommonMark + GFM and enforces strict Zero-XSS sanitization with iframe sandboxing.

afterParse Lifecycle Hooks

Allows plugin extensions to inspect or mutate the safe sanitized HTML before DOM mounting.

DOM Mounting & Link Resolution

Mounts HTML into #verti-app and transforms relative links (../guide.md → #/guides/guide.md).

afterRender Plugins

Initializes Prism syntax highlighting, KaTeX mathematical formulas, Mermaid diagrams, and image zooms.

Table of Contents & Scrollspy

Constructs the heading tree and registers IntersectionObserver for active section tracking.

Search Indexing & AEO Microdata

Indexes the document tokens in MiniSearch and updates Schema.org TechArticle JSON-LD microdata.

Technical Comparison

Why Developers Choose VertiWiki

See how VertiWiki compares with traditional static site generators and legacy wikis.

Architectural Feature	VertiWiki Standard	Traditional SSGs (Docusaurus, VitePress)	Legacy Wikis (DokuWiki, MediaWiki)
Hosting Model	100% Static (Any HTTP Server, CDN, S3, Git Pages)	Static build artifact (Requires CI/CD)	PHP / Node / Database server required
Content Update Pipeline	0s (Instant live refresh upon editing .md)	30s - 3min (CI/CD rebuild & deploy)	Direct database write or PHP file lock
Search Engine	In-browser MiniSearch index (Zero latency)	Algolia DocSearch or pre-computed JSON	Server-side SQL fulltext search
Diagrams & Math	Native client-side Mermaid & KaTeX	Plugin dependencies & build transforms	Server extensions (Mathoid, Graphviz)
Security Surface	Strict DOMPurify sandbox, zero backend vectors	Build-time npm dependency chain risk	SQL injection, PHP vulnerabilities
Autonomous AI Optimization	Native llms.txt + Schema.org JSON-LD	Manual plugin integration	Absent

Getting Started

Ready in 3 Simple Steps

No complex Node.js build pipelines and no databases required.

STEP 01

Write Content in Markdown

Create your index.md, subfolders (e.g. concepts/), and navigation manifest in navigation.md.

mkdir -p my-wiki && touch index.md navigation.md

STEP 02

Download Engine

Download the pre-compiled standalone engine bundle directly from GitHub Releases into your root directory.

curl -fsSL https://github.com/Octadira/vertiwiki/releases/latest/download/vertiwiki.html -o index.html

STEP 03

Deploy & Host Anywhere

Deploy to GitHub Pages, Cloudflare Pages, S3, or test locally with any static HTTP server.

npx serve . # or python3 -m http.server

Frequently Asked Questions

Technical Clarifications

Answers to architectural questions regarding client-side execution, security, bot crawling, and performance.

How does VertiWiki work without a server-side build step? +

VertiWiki executes 100% inside the browser client. When a route is requested, it fetches the raw Markdown via fetch(), parses YAML frontmatter, executes pipeline hooks, compiles with Marked v15, sanitizes through DOMPurify, and mounts into the DOM in under 2ms.

How does relative link resolution work in subfolders? +

VertiWiki incorporates an automated link transformer (router.transformLinks()) that computes relative directory traversal paths based on the active file path, guaranteeing that relative Markdown links and images resolve accurately across nested folders.

How does Answer Engine Optimization (AEO) help AI crawlers? +

On every route transition, VertiWiki generates dynamic Schema.org TechArticle and BreadcrumbList microdata, serves a structured llms.txt index adhering to AgentDocsSpec, and offers a 1-click Markdown copy button for autonomous coding agents.

Can VertiWiki run completely offline or on an air-gapped network? +

Yes. All styles, fonts (WOFF2), KaTeX formulas, and Mermaid libraries are bundled into the single index.html payload. With a lightweight static server (e.g. python3 -m http.server), it functions 100% offline without internet access.

How do I create and load custom theme presets? +

Create JSON files in your themes/ directory declaring CSS variables for light/dark palettes. Register them in config.json under "customThemes" and they become instantly selectable without code compilation.

How do search bots index VertiWiki without server-side rendering (SSR)? +

VertiWiki embeds a Static Bot Crawl Tree directly into the loading HTML shell. Search crawlers discover standard anchor links to every document immediately upon the first HTTP request.

Ready to Experience Zero-Backend Documentation?

Explore the embedded VertiWiki documentation portal directly in your browser or inspect the source repository on GitHub.

Open Documentation Portal GitHub Repository