gate_bak icon indicating copy to clipboard operation
gate_bak copied to clipboard

Published 20 hours ago • verified publisher icon sarasate
→

Metadata

Static API documentation with GatsbyJS

Gate generates pretty and well structured API documentation.

Heavily inspired by Slate, and hence by Stripes API docs. You can use the same markdown files as in slate.

Demo

Features

  • Clean and simple design

  • Single Page Layout

  • Markdown source

  • Syntax highlighting

Get started

Prerequisites

What you need:

Set Up

  1. Fork this repository on GitHub.
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/gate.git
  3. cd gate
  4. Start Gate: gatsby develop

Your docs are now available at http://localhost:8000. Easy.

Companies Using Gate

Limitations / Issues

Syntax Highlighting: Currently only bash is processed by prismjs. shell or curl don't work.

Questions? Help needed? Found a bug?

Found a bug? Please submit an issue.

Contributors

Built by Luis Höfer

← Metadata

21
Stars
29
Forks
Watchers

Owner

verified publisher icon sarasate

Metadata

Static API documentation with GatsbyJS

Back