pheature-flags / api-docs Goto Github PK

This repository hosts the API documentation of Pheature Flags. It builds OpenAPI 3 specifications into a static website. It also includes local development tools and utils using Make rules.

It was created with Slate. Check it out at Slate Docs.

Please make sure you have widdershins installed

Place your desired OAS3 YAML file at source/specs/

For example: client.yaml

make generate API=client

Use the following command to launch a Docker container of the Slate image:

make serve

Visit http://localhost:4567 to see the changes

All customizations are preserved across several make generations because of the use of diff & patch.

This Make rule works as long as:

1. Exist a valid spec at source/specs/${API}.yaml
2. ${API} is included in the includes: section of source/index.html.md

includes: 
  - client
  - crud