An open API service indexing awesome lists of open source software.

https://github.com/bolt/api-docs

A simple repository to create Bolt 4 API docs, using Doctum
https://github.com/bolt/api-docs

Last synced: 3 months ago
JSON representation

A simple repository to create Bolt 4 API docs, using Doctum

Awesome Lists containing this project

README

        

Bolt API documentation
======================

Find the live version of the output at: https://api-docs.boltcms.io/

This is a small repository to create the API docs for Bolt 4.

## Usage

First, clone this repo, and go into the newly created folder. Then:

```bash
composer install
git clone [email protected]:bolt/core.git
rm -rf core/var/cache/*
php vendor/bin/doctum.php update config.php
```

The `build/` folder will now contain the latest version of the built docs.

## Deployment

If you're me, and reading this anytime in the near future: Here's how to deploy
the output:

```bash
scp -r build/* [email protected]:./domains/api-docs.boltcms.io/public_html/
```