PHPackages zephyrus-framework/leaf - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. zephyrus-framework/leaf ActiveProject[Framework](/categories/framework) zephyrus-framework/leaf ======================= Project template for Zephyrus Leaf static sites. Docs, blogs, landing pages. 00CSS Since Apr 19Pushed 1mo agoCompare [ Source](https://github.com/ophelios-studio/zephyrus-leaf)[ Packagist](https://packagist.org/packages/zephyrus-framework/leaf)[ RSS](/packages/zephyrus-framework-leaf/feed)WikiDiscussions main Synced 1w ago READMEChangelogDependenciesVersions (1)Used By (0) Zephyrus Leaf ============= [](#zephyrus-leaf) A static documentation site generator powered by [Zephyrus](https://github.com/zephyrus-framework/core). Write your docs in Markdown, develop with live-reload, and build to static HTML with a single command. Features -------- [](#features) - **Markdown content** -- YAML frontmatter, GFM tables, fenced code blocks, heading permalinks - **Automatic navigation** -- Sidebar and table of contents generated from your content structure - **Full-text search** -- Client-side fuzzy search across all pages, no server required - **Syntax highlighting** -- Prism.js with support for PHP, JavaScript, TypeScript, Bash, YAML, JSON, SQL, and Solidity - **Dark theme** -- Electric violet on deep black. Single theme, no toggle needed - **One-command build** -- `composer build` generates a `dist/` folder ready for GitHub Pages, Netlify, or any static host - **Live-reload** -- Edit a file, see changes instantly during development - **Mobile responsive** -- Hamburger menu with slide-in sidebar drawer on small screens Requirements ------------ [](#requirements) - PHP 8.4+ - Composer - `ext-intl` and `ext-mbstring` Quick Start ----------- [](#quick-start) ``` # Clone or create a new project composer create-project dadajuice/zephyrus-leaf my-docs cd my-docs # Start the dev server with live-reload composer dev ``` Open in your browser. Project Structure ----------------- [](#project-structure) ``` my-docs/ ├── config.yml # Site identity, sections, and build settings ├── content/ # Markdown documentation pages │ └── getting-started/ │ └── introduction.md ├── app/ │ ├── Controllers/ # Route handlers │ ├── Models/Core/ # Application bootstrap │ └── Views/ # Latte templates │ ├── docs/page.latte │ ├── layouts/ │ └── partials/ # Nav, sidebar, footer, search, TOC ├── public/ │ ├── assets/ │ │ ├── css/app.css # Full theme CSS │ │ ├── js/ # Copy-code, sidebar, search scripts │ │ └── images/ # Your logo and assets │ └── index.php ├── src/ # Leaf library classes ├── bin/ │ ├── router.php # Dev server entry point │ └── build.php # Static site builder └── dist/ # Built static output (after composer build) ``` Writing Content --------------- [](#writing-content) ### Pages [](#pages) Create Markdown files in `content/{section}/{page}.md`. Each file needs YAML frontmatter: ``` --- title: Installation order: 2 --- # Installation Your content here... ``` The `title` appears in the sidebar. The `order` controls the sort order within a section (lower numbers come first). ### Sections [](#sections) Define sections and their display names in `config.yml`: ``` leaf: sections: getting-started: "Getting Started" guides: "Guides" api-reference: "API Reference" ``` The order in the YAML file determines the sidebar order. Create a matching directory under `content/` for each section. ### Cross-references [](#cross-references) Link between pages using absolute paths: ``` See the [Installation](/getting-started/installation) guide. ``` Configuration ------------- [](#configuration) All site settings live in the `leaf:` section of `config.yml`: ``` leaf: name: "My Project" # Displayed in the navbar version: "1.0.0" # Version badge in the navbar description: "A short tagline" # Used in meta tags github_url: "" # GitHub link in the navbar (leave empty to hide) content_path: "content" # Where markdown files live sections: # Sidebar sections (order matters) getting-started: "Getting Started" output_path: "dist" # Static build output directory base_url: "" # Base URL for production (e.g. "/docs") author: "Your Name" # Displayed in the sidebar footer author_url: "" # Author link license: "MIT" # License badge in the footer ``` Customization ------------- [](#customization) ### Logo [](#logo) Replace the default SVG icon in `app/Views/partials/nav.latte` with your own logo. For an image logo, use: ``` ``` ### Theme [](#theme) The design system is defined as CSS custom properties in `public/assets/css/app.css`: TokenDefaultUsage`--bg-deep``#08080d`Page background`--bg-surface``#11111a`Sidebar, cards, code blocks`--bg-elevated``#1a1a27`Hover states`--accent``#8b5cf6`Primary accent (violet)`--accent-light``#a78bfa`Hover accent`--text``#d4d4d8`Body text`--text-bright``#fafafa`Headings`--font-body`InterBody font`--font-mono`JetBrains MonoCode font### Syntax Highlighting [](#syntax-highlighting) Additional Prism.js languages can be added in `app/Views/layouts/docs.latte`: ``` ``` Commands -------- [](#commands) ``` composer dev # Start dev server with live-reload (localhost:8080) composer build # Generate static HTML to dist/ composer test # Run tests ``` Deployment ---------- [](#deployment) After running `composer build`, the `dist/` directory contains a fully self-contained static site. Deploy it to any static hosting: **GitHub Pages** -- Push `dist/` to a `gh-pages` branch or configure GitHub Pages to serve from `dist/` on `main`. **Netlify / Vercel** -- Point the build output directory to `dist/`. **Manual** -- Upload the contents of `dist/` to any web server. The build also generates a `404.html` at the root of `dist/` for GitHub Pages compatibility. License ------- [](#license) MIT ### Health Score 19 — LowBetter than 10% of packages Maintenance59 Moderate activity, may be stable Popularity0 Limited adoption so far Community6 Small or concentrated contributor base Maturity11 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://avatars.githubusercontent.com/u/118052280?v=4)[ophelios](/maintainers/ophelios)[@Ophelios](https://github.com/Ophelios) --- Top Contributors [![dadajuice](https://avatars.githubusercontent.com/u/4491532?v=4)](https://github.com/dadajuice "dadajuice (4 commits)") ### Embed Badge ![Health badge](/badges/zephyrus-framework-leaf/health.svg) ``` [![Health](https://phpackages.com/badges/zephyrus-framework-leaf/health.svg)](https://phpackages.com/packages/zephyrus-framework-leaf) ``` ### Alternatives [laravel/socialite Laravel wrapper around OAuth 1 & OAuth 2 libraries. 5.7k104.3M822](/packages/laravel-socialite)[laravel/dusk Laravel Dusk provides simple end-to-end testing and browser automation. 1.9k38.6M289](/packages/laravel-dusk)[pinguo/php-msf Pinguo Micro Service Framework For PHP 1.7k4.2k](/packages/pinguo-php-msf)[nineinchnick/edatatables Grid widget for the Yii Framework, wrapper for the DataTables jQuery plugin 173.2k](/packages/nineinchnick-edatatables) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)