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
- Host: GitHub
- URL: https://github.com/bolt/api-docs
- Owner: bolt
- Created: 2019-11-02T09:33:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-30T20:00:14.000Z (over 2 years ago)
- Last Synced: 2025-01-18T08:38:06.810Z (5 months ago)
- Language: PHP
- Homepage: https://api-docs.boltcms.io
- Size: 27.3 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
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/
```