Download the PHP package ezar101/litedocs without Composer
On this page you can find all versions of the php package ezar101/litedocs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package litedocs
LiteDocs
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
✨ 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
Option 1: Standalone PHAR (Recommended)
You can download the single executable file from the Releases Page.
Option 2: Via Composer
🏁 Quick Start
- Initialize a new project Create a litedocs.yml file and a docs/ folder with some markdown files.
-
Build the site Run the build command in your project directory:
-
Development Mode (Optional) To automatically rebuild the site whenever you change a file:
Tip: Open a second terminal and run
php -S localhost:8000 -t siteto view your changes live. - Enjoy Your static site is generated in the site/ directory, ready to be deployed to GitHub Pages, Vercel, or Netlify.
⚙️ Configuration
Create a litedocs.yml file at the root of your project:
🤝 Contributing
Contributions are welcome! We enforce high code quality standards to keep the project maintainable.
Requirements
- PHP 8.4+
- Composer
Development Workflow
- Fork the repository and create a new branch.
-
Install dependencies:
-
Write Tests: We use Pest PHP.
-
Analyze Code: Ensure static analysis passes.
-
Fix Style: Format your code to PSR-12 standards.
- Submit a Pull Request.
Note: Our CI pipeline will automatically block any PR that does not pass tests or static analysis.
📄 License
LiteDocs is open-sourced software licensed under the MIT license.
All versions of litedocs with dependencies
symfony/console Version ^7.0|^8.0
symfony/yaml Version ^7.0|^8.0
symfony/filesystem Version ^7.0|^8.0
symfony/event-dispatcher Version ^7.0|^8.0
symfony/options-resolver Version ^7.0|^8.0
twig/twig Version ^3.22
league/commonmark Version ^2.8
symfony/finder Version ^7.0|^8.0