GithubHelp home page GithubHelp logo

gate's Introduction

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

gate's People

Contributors

ijkeleher avatar

Watchers

James Cloos avatar

Forkers

robertk3000

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.