Meet Markify: The Zero-Install, Zero-Build Documentation Engine
Building technical documentation shouldn't require downloading hundreds of megabytes of node_modules or configuring complex JavaScript build pipelines.
If you are tired of build steps breaking just to update a few Markdown pages, meet Markify.
What is Markify?
Markify is a lightweight, zero-install, zero-build client-side documentation engine. It fetches raw Markdown files directly in the browser using modern Web APIs and renders them into a sleek, interactive Single Page Application (SPA).
Zero Setup: No npm install, no Webpack, no Vite.
Glassmorphic UI: Built-in modern glassmorphism design with dynamic Light and Dark mode support.
Instant Search: Client-side full-text search powered by FlexSearch with Ctrl + K shortcut support.
Dynamic ToC: Automatic Table of Contents generated from your headings.
Code Copy and Highlight: One-click code snippet copying with Prism.js syntax highlighting.
Quick Start in 2 Minutes
All you need is a single index.html file in your repository.
File Structure
my-docs/
├── index.html
├── _sidebar.md
└── README.md
Define Navigation (_sidebar.md)
Getting Started
Home
Quick Start
Configuration
Launch
Serve your folder using any local HTTP server (like VS Code Live Server or python3 -m http.server 8000), and your documentation is live!
Try It Out and Contribute
Markify is completely open-source under the CC-BY-NC-SA 4.0 license.
GitHub Repository: https://github.com/Markify-tools/home
Documentation Wiki: https://github.com/Markify-tools/home/wiki
Give it a star on GitHub if you find it useful, and feel free to share your feedback below!
Top comments (0)