A Zero-Dependency Documentation Compiler
Lightweight and Zero-Dependency
Documentation should not require hundreds of megabytes of frameworks.
We believed that a simple wiki, developer guide, or API documentation portal should compile instantly and run without any external resource constraints.
That is why Glyph was built with zero dependencies. No Webpack, no heavy JavaScript runtimes, no complex bundlers. It is written using pure JavaScript to parse raw Markdown and MDX files into beautiful static pages.
Fast Static Compilation
A compilation pipeline built directly on top of V8.
Under the project's measured benchmark conditions, individual markdown pages compile in under 10ms, and typical documentation directories build into a self-contained production-ready output folder in under 50ms.
Simply run the command: node bin/compiler.js build
And the docs folder is compiled into clean static HTML, CSS, and JS ready for local use or web deployment.
Fuzzy Client-Side Search
Local indexing without external search services.
Most modern portals require complex external search indexes. Glyph eliminates external API dependencies.
During compilation, Glyph extracts titles, descriptions, and plain text from your pages into a lightweight local JSON index. Users get responsive fuzzy matching directly in the browser.
Live Rebuilding & Dev Server
A reactive environment built for fast writing.
Running the preview server launches a lightweight HTTP listener at localhost:3000 and watches your source documents for edits.
By implementing a debounced file watcher, saving any file inside the source directory triggers an automatic local rebuild, quickly refreshing your preview.
Clean Developer Aesthetics
Optimized layouts optimized for readability.
Featuring a built-in glowing dark theme, Glyph comes pre-packaged with modern glassmorphism sidebars, code highlight styling, page-to-page navigation pagers, and native support for GitHub-style blockquote alerts (NOTE, TIP, WARNING, IMPORTANT).
Glyph
Complete guide to building, configuring, and publishing static developer documentation hubs.
node bin/compiler.js build
Compiles docs/to static production HTML & search indexes.
node bin/compiler.js dev 3000
Runs live local preview server at localhost:3000 with auto-reload.
Add YAML header: title, description, order to customize sidebar navigation.
Supports [!NOTE], [!TIP], [!WARNING] blockquotes rendered as glowing cards.
docs/ to update your portal instantly.“Restoring human weight and speed
Glyph - A SHRI Ecosystem Project
Get the
Explore the documentation portal, installation guide, and source code on GitHub.