Official starter templates for building documentation sites with Agahi
Agahi is a zero-build, client-side documentation engine that renders .md files directly in your browser - no bundlers, no build step, no server required.
- No Build Step: Add or update
.mdand refresh the browser. - Client-Side: All rendering happens in-browser using native Markdown.
- Static-Host Ready: Perfect for GitHub Pages, Netlify, Vercel, and any static hosts.
- Lightweight & Extensible: Start with defaults or customize via a minimal config.
- Prebuilt folder structure & sample Markdown
- Theme & layout support via CDN CSS/JS
- Configurable Sidebar, Title, Repo links
- Plugin-ready for code copy, image zoom, TOC, and more
_agahi/
├── navbar.md # Top navigation bar content
├── sidebar.md # Sidebar navigation links
└── footer.md # Footer content & links
.nojekyll # Prevent GitHub Pages from skipping hidden files
index.html # Main entry point (configure Agahi here)
README.md # Project overview & setup instructions
guide/ # Example content folder
├── getting-started.md
└── usage.md
-
Clone the template
git clone https://github.com/tenelabs/agahi-starter.git my-docs cd my-docs -
Open it up Just click
index.htmland serve it. -
Customize
- Add or modify Markdown files.
- Configure
window.$agahiinindex.htmlfor title, repo link, plugins, etc.
In your index.html:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>My Docs</title>
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/agahi@latest/dist/theme/light.min.css"
/>
</head>
<body>
<div id="app"></div>
<script>
window.$agahi = {
name: "My Docs",
repo: "your-github-owner/your-docs-repo",
el: "app",
};
</script>
<script src="https://cdn.jsdelivr.net/npm/agahi@latest/dist/agahi.min.js"></script>
</body>
</html>Then link between pages with Markdown hashes:
[Go to Usage Guide](#/guide/usage.md)Learn about advanced config, themes, deployment, plugin usage and more: