mistralys / application-framework-docs

1.0.1 2024-10-30 15:56 UTC

Requires

• php: >=7.4
• mistralys/markdown-viewer: >=1.3.1

Requires (Dev)

• roave/security-advisories: dev-latest

MIT

• smordziol

Published on Packagist.org on 2024-10-30 15:57 UTC

README

Introduction

This is the documentation hub for the Application Framework. It contains the documentation for all components of the framework, including a PHP-based web UI that can be used to browse the documentation.

It is based on Markdown-styled documents which can be accessed either via Github by browsing into the documents folder, or via the bundled web UI.

Web UI installation

• Clone the repository into a web-accessible folder.
• Run composer install to install the dependencies.
• Open the documentation via htdocs.