https://github.com/getgrav/grav-api
Grav API Documentation
https://github.com/getgrav/grav-api
api-documentation developer documentation grav
Last synced: 4 months ago
JSON representation
Grav API Documentation
- Host: GitHub
- URL: https://github.com/getgrav/grav-api
- Owner: getgrav
- License: mit
- Created: 2015-12-08T20:23:41.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-09T03:02:10.000Z (over 10 years ago)
- Last Synced: 2025-09-25T06:30:25.851Z (9 months ago)
- Topics: api-documentation, developer, documentation, grav
- Language: HTML
- Homepage: https://getgrav.org
- Size: 689 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Grav API
This is the generated result of the [Sami - the API documentation generator](https://github.com/FriendsOfPHP/Sami).
Generated based on the following configuration:
```
files()
->name('*.php')
->exclude('Resources')
->exclude('Tests')
->exclude('tests')
->in($dir = __DIR__.'/../grav/system/src')
->in($dir = __DIR__.'/../grav/vendor/rockettheme')
;
return new Sami($iterator, array(
'theme' => 'default',
'title' => 'Grav API',
'build_dir' => __DIR__.'/api',
'cache_dir' => __DIR__.'/cache/api',
'default_opened_level' => 2
));
```
To regenerate, follow these steps:
1. Ensure you have this repo `grav-api` cloned at the same level as `grav` itself.
2. [Install Sami](https://github.com/FriendsOfPHP/Sami#installation) per the installation instructions.
3. run: `~//Sami/sami.php update ./api-config.php`