PHPackages                             kekos/prest-doc - 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. [HTTP & Networking](/categories/http)
4. /
5. kekos/prest-doc

ActiveLibrary[HTTP & Networking](/categories/http)

kekos/prest-doc
===============

Static Site Generator for OpenAPI documentation

v0.4.1(3mo ago)0196↓100%MITPHPPHP ~8.1.0 || ~8.2.0 || ~8.3.0

Since Mar 30Pushed 3mo ago1 watchersCompare

[ Source](https://github.com/Kekos/prest-doc)[ Packagist](https://packagist.org/packages/kekos/prest-doc)[ RSS](/packages/kekos-prest-doc/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (5)Versions (9)Used By (0)

Prest-doc
=========

[](#prest-doc)

Static Site Generator for OpenAPI documentation written in PHP.

Install
-------

[](#install)

```
composer require kekos/prest-doc

```

Requires at least PHP 8.1.

Usage
-----

[](#usage)

```
./bin/prest-doc    []

```

- `` points to a directory which Prest-doc should read and convert.
- `` points to a directory where converted files will be written. **Please note that this directory will be deleted by Prest-doc on each run**
- `` is a file path to layout file. See the [`examples/`](examples) directory.
- `` is a file path to [configuration](#configuration). *Optional*.

Configuration
-------------

[](#configuration)

### API templates

[](#api-templates)

You can override the default OpenAPI Markdown templates by creating a configuration file and supply it with your own instances of template interfaces:

```