design/api/README.md
author salimr <riwad.salim@yahoo.fr>
Fri, 31 Aug 2018 15:14:18 +0200
changeset 151 57d63a248f0d
parent 116 672e3c4bbd0c
permissions -rw-r--r--
Update to Bootstrap 4

# Generation of API documentation

The documentation use the api blueprint format ([documentation](https://apiblueprint.org)).

[Aglio](https://github.com/danielgtaylor/aglio) is used for rendering the documentation into html.

## install Aglio

```bash
$ npm install
```

### Available commands

- Build the documentation (file metacategory.html)
```bash
$ npm run build
```

This runs the following command:
```bash
$ aglio -i metacategory.apib -o metacategory.html
```

- Watch the documentation.
```bash
$ npm run watch
```

This runs the following command:
```bash
aglio -i metacategory.apib -s
```