Documentation

CLI doc

See Usage.

Library doc

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

You can consult it online on GitHub or on RubyDoc.

Building locally: for library users

For developers who only want to use the library.

bundle exec yard doc

Serve locally

Serve with live reload:

bundle exec yard server --reload

Documentation available at: http://localhost:8808/