Home

Table of Contents Welcome to the Markify Wiki 🚀 Quick Links 🔗 What is Markify? Core Features ✨ Getting Started in 3 Steps Step 1: File Structure Step 2: Define Navigation (_sidebar.md) Step 3: Run Local Server License & Attribution

Welcome to the Markify Wiki 🚀

Welcome to the official documentation and knowledge base for Markify—the zero-install, zero-build modern documentation engine for developers.

Quick Links 🔗

📦 Download Latest Release: Markify Releases
🌐 Live Website: Markify Home Page
📜 License: CC-BY-NC-SA 4.0 International

What is Markify?

Markify is a lightweight client-side documentation generator designed to convert plain Markdown files directly into a modern, fully interactive Single Page Application (SPA) inside the browser.

Unlike traditional static site generators, Markify requires no Node.js, no npm dependencies, and no build compilation steps.

Core Features ✨

⚡ Zero Setup & Zero Build: Works straight out of the box with just a single index.html file.
🎨 Glassmorphism UI: Built-in modern glassmorphic layout with Light and Dark mode support.
🔍 Instant Full-Text Search: Integrated client-side search powered by FlexSearch (Ctrl + K).
📌 Floating ToC: Dynamic Table of Contents generated automatically from headings.
💻 Code Snippets: Syntax highlighting via Prism.js with one-click code copy buttons.
📁 Dynamic Sidebar: Auto-generated navigation menu built directly from your _sidebar.md file.

Getting Started in 3 Steps

Step 1: File Structure

Set up your workspace with the following basic files:

my-docs/
├── index.html
├── _sidebar.md
└── README.md

Step 2: Define Navigation (_sidebar.md)

Add your page structure using standard Markdown links:

* **Getting Started**
  * [Home](README)
  * [Quick Start](quickstart)
  * [Configuration](configuration)

Step 3: Run Local Server

Because Markify uses client-side fetch(), open your project using any local HTTP server (such as VS Code Live Server or python3 -m http.server 8000).

License & Attribution

Markify is shared under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC-BY-NC-SA 4.0) license. Feel free to adapt and share for non-commercial projects.

Navigation Menu