Sha256: e2527aa0f1119c474bb03cd237a4440a754ef1d714fd30ee2f02e7bdfab36c21

Contents?: true

Size: 603 Bytes

Versions: 4

Compression:

Stored size: 603 Bytes

Contents

# Documentation 

## CLI doc

See [Usage](pages/usage.md?id=cli).

## Server locally

```
$ npm i docsify-cli -g
$ docsify serve docs
```

## Library doc

The output directory of the library documentation will be `docs/yard`.

You can consult it online [here](https://orange-cyberdefense.github.io/rabid/yard/).

### Building locally: for library users

For developers who only want to use the RABID library.

```
$ bundle exec yard doc
```

### Building locally: for RABID developer

For developers who want to participate to RABID development.

```
$ bundle exec yard doc --yardopts .yardopts-dev
```

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
rabid-0.0.5 docs/pages/documentation.md
rabid-0.0.4 docs/pages/documentation.md
rabid-0.0.3 docs/pages/documentation.md
rabid-0.0.2 docs/pages/documentation.md