Skip to content

README.md

Latest commit

 

History

History
44 lines (30 loc) · 1.01 KB

README.md

File metadata and controls

44 lines (30 loc) · 1.01 KB

Routegy Docs (API)

Public documentation for the Routegy API at https://api.docs.routegy.com.

tl;dr

This project converts a swagger (OpenApi 2.0) spec file into a Slate markdown document which is converted into html.

Quick Start

  1. Convert the swagger config into Slate markdown:
make build-swagger
  1. Host the slate docs locally:
make serve
  1. Build docs into static site:
make build

Usage

⇒  make help
build-swagger                  Build swagger spec into slate markdown
build-slate                    Build slate site from markdown
build                          Build site
clean                          Clean local compiled site
serve                          Serve locally at https://localhost:4567
help                           Print Makefile usage.

Dependencies