Note: This project is not finished and is under active development. Contributions welcome!
Jekyll/OpenAPI is an OpenAPI 3 documentation website generator built with Jekyll for use on GitHub Pages.
Jekyll is a static website generator that works seamlessly with GitHub Pages, whilst the OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for REST APIs. Put this all together and you get a fast, secure and highly customisable static website with free hosting for your API documentation.
Table of Contents
Before you begin, ensure you've installed Jekyll. Then:
$ git clone https://github.com/robertlove/jekyll-openapi.git
$ cd jekyll-openapi
$ bundle install
$ bundle exec jekyll serve
If all went well, you'll be able to view your new Jekyll/OpenAPI website locally by going to http://127.0.0.1:4000/jekyll-openapi/ in your browser.
_data/openapi.json with your own API description, refresh your browser, and voilà!
Note: This project is built with Jekyll/Bootstrap. See Jekyll/Bootstrap Usage for more usage information - including instructions on how to change the look and feel of your API documentation.