Skip to content
Sean Molenaar edited this page Jul 20, 2018 · 5 revisions

Of course you love to use a CLI, otherwise you'd be using apiary.

The following options can be used:

-f Specifies the file to parse.

This one is the only one that's actually required. What good is a parser without stuff to parse right?

-o Always use the online mode.

Use an only version of drafter instead of a locally installed one.

-t Specifies the template to use.

You can read more about this on the template page

-s Sort displayed values

Takes one of the following options:

  1. All
  2. None
  3. Structures <- MSON Structures defined to be used in # Data structures
  4. Webservices <- API Blueprint calls them resources. Basically sorts by all elements in a # group <key>

-i Specifies an image to display in the header.

-c Specifies a CSS file to include (value is put in a link element without checking).

-j Specifies a JS file to include (value is put in a script element without checking).

-h Displays this text.

The following environment variables can be set to change the way the application behaves

PHPDRAFT_THIRD_PARTY: If the application is allowed to use external URLs to attempt requests for example.

COLOR_PRIMARY: The primary color for the material theme.

COLOR_SECONDARY: The secondary color for the material theme.

Clone this wiki locally