Skip to content

webilhan/jekyll-swagger

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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/.

About

Swagger API doc within jekyll (works with gh-pages)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 71.9%
  • CSS 28.1%