Giter Club home page Giter Club logo

jekyll-swagger's Introduction

Swagger API doc within jekyll

http://jexhson.github.io/jekyll-swagger/

jekyll-swagger is a Jekyll layout that allow you to include a Swagger API documentation directly in a page. Checkout examples to see how it renders!

Bonus: jekyll-swagger works with GitHub pages!

Usage instruction

  1. Download jekyll-swagger (you can also clone it).
  2. Copy _layouts/swagger.html and _saas/_swagger.scss into your jekyll site.
  3. Add import swagger in css/main.scss (like here)
  4. You can now create pages with the swagger layout (layout: swagger).

Swagger API doc can be either within the page or in a separate file and specified in your page with data front matter (like here).

License

jekyll-swagger is released under the MIT License. See LICENSE file for details.

Links

The official site for the library is at http://jexhson.github.io/jekyll-swagger/.

jekyll-swagger's People

Watchers

James Cloos avatar Mahesh Subramaniya avatar avatar

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.