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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package litedocs

LiteDocs

Build Status Quality Status Latest Release

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

🚀 Installation

Option 1: Standalone PHAR (Recommended)

You can download the single executable file from the Releases Page.

Option 2: Via Composer

🏁 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:

  3. 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 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

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

Development Workflow

  1. Fork the repository and create a new branch.
  2. Install dependencies:

  3. Write Tests: We use Pest PHP.

  4. Analyze Code: Ensure static analysis passes.

  5. Fix Style: Format your code to PSR-12 standards.

  6. 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

PHP Build Version
Package Version
Requires php Version >=8.4
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
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ezar101/litedocs contains the following files

Loading the files please wait ...