PHPackages ezar101/litedocs - 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. [Utility & Helpers](/categories/utility) 4. / 5. ezar101/litedocs ActiveLibrary[Utility & Helpers](/categories/utility) ezar101/litedocs ================ A lightweight static site generator. v1.0.4(4mo ago)10MITPHPPHP >=8.4CI passing Since Dec 7Pushed 4mo agoCompare [ Source](https://github.com/Ezar101/LiteDocs)[ Packagist](https://packagist.org/packages/ezar101/litedocs)[ RSS](/packages/ezar101-litedocs/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (4)Dependencies (12)Versions (6)Used By (0) [![LiteDocs Logo](.assets/logo.png)](.assets/logo.png) LiteDocs ======== [](#litedocs) [![Build Status](https://github.com/Ezar101/LiteDocs/actions/workflows/build.yml/badge.svg)](https://github.com/Ezar101/LiteDocs/actions) [![Quality Status](https://github.com/Ezar101/LiteDocs/actions/workflows/quality.yml/badge.svg)](https://github.com/Ezar101/LiteDocs/actions) [![Latest Release](https://camo.githubusercontent.com/e03248eb4babc77aabb283da3663efda1d26d281257d6b38a96d84721f65e7d3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f457a61723130312f4c697465446f6373)](https://github.com/Ezar101/LiteDocs/releases) [![License](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](LICENSE) **LiteDocs** is a modern, lightweight, and blazing fast static site generator written in PHP 8.4+. It is designed to build beautiful documentation sites from Markdown files with zero configuration. [**πŸ“š Read the Official Documentation**](https://Ezar101.github.io/LiteDocs/) --- ✨ Features ---------- [](#-features) - **⚑ Zero Config:** Works out of the box with sensible defaults. - **🎨 Theming:** Powerful templating engine based on **Twig**. Includes a modern "Lite" theme. - **πŸ”Œ Plugins:** Extensible architecture using Symfony EventDispatcher. - **🌍 Multilingual:** Native support for internationalization (i18n). - **πŸ” Search:** Built-in client-side search engine (no external services required). - **πŸ›  Developer Friendly:** 100% PHP, easy to override and extend. πŸš€ Installation -------------- [](#-installation) ### Option 1: Standalone PHAR (Recommended) [](#option-1-standalone-phar-recommended) You can download the single executable file from the [Releases Page](https://github.com/Ezar101/LiteDocs/releases). ``` wget https://github.com/Ezar101/LiteDocs/releases/latest/download/litedocs.phar chmod +x litedocs.phar sudo mv litedocs.phar /usr/local/bin/litedocs ``` ### Option 2: Via Composer [](#option-2-via-composer) ``` composer global require Ezar101/litedocs ``` 🏁 Quick Start ------------- [](#-quick-start) 1. **Initialize a new project** Create a litedocs.yml file and a docs/ folder with some markdown files. 2. **Build the site** Run the build command in your project directory: ``` litedocs build ``` 3. **Development Mode (Optional)**To automatically rebuild the site whenever you change a file: ``` litedocs watch ``` *Tip: Open a second terminal and run `php -S localhost:8000 -t site` to view your changes live.* 4. Enjoy Your static site is generated in the site/ directory, ready to be deployed to GitHub Pages, Vercel, or Netlify. βš™οΈ Configuration ---------------- [](#️-configuration) Create a `litedocs.yml` file at the root of your project: ``` site_name: "My Awesome Docs" docs_dir: "docs" site_dir: "site" # Enable multilingual support languages: en: English fr: FranΓ§ais # Theme configuration theme: name: lite # Import navigation and plugins nav: "config/nav.yml" plugins: "config/plugins.yml" ``` 🀝 Contributing -------------- [](#-contributing) Contributions are welcome! We enforce high code quality standards to keep the project maintainable. ### Requirements [](#requirements) - PHP 8.4+ - Composer ### Development Workflow [](#development-workflow) 1. **Fork** the repository and create a new branch. 2. Install dependencies: ``` composer install ``` 3. **Write Tests**: We use [Pest PHP](https://pestphp.com/). ``` composer test ``` 4. **Analyze Code**: Ensure static analysis passes. ``` composer analyse ``` 5. **Fix Style:** Format your code to PSR-12 standards. ``` composer lint # Check composer fix # Auto-fix ``` 6. Submit a **Pull Request**. **Note:** Our CI pipeline will automatically block any PR that does not pass tests or static analysis. πŸ“„ License --------- [](#-license) LiteDocs is open-sourced software licensed under the [MIT license](https://www.google.com/search?q=LICENSE). ### Health Score 37 β€” LowBetter than 83% of packages Maintenance74 Regular maintenance activity Popularity2 Limited adoption so far Community6 Small or concentrated contributor base Maturity56 Maturing project, gaining track record 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. ### Release Activity Cadence Every ~6 days Total 4 Last Release 144d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/3f6513208a33ad31caf05fcf53a287d8cb7e7b08759311990367eb88a5f6a79c?d=identicon)[Ezar](/maintainers/Ezar) --- Top Contributors [![Ezar101](https://avatars.githubusercontent.com/u/29166550?v=4)](https://github.com/Ezar101 "Ezar101 (20 commits)") ### Code Quality TestsPest Static AnalysisPHPStan Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/ezar101-litedocs/health.svg) ``` [![Health](https://phpackages.com/badges/ezar101-litedocs/health.svg)](https://phpackages.com/packages/ezar101-litedocs) ``` ### Alternatives [sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[contao/core-bundle Contao Open Source CMS 1231.6M2.4k](/packages/contao-core-bundle)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[drupal/core Drupal is an open source content management platform powering millions of websites and applications. 19462.3M1.3k](/packages/drupal-core)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.3M152](/packages/sulu-sulu) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)