Git Product home page Git Product logo

colin-alexander-cacars / api-documentation-html-template Goto Github PK

View Code? Open in Web Editor NEW

This project forked from floriannicolas/api-documentation-html-template

0.0 0.0 0.0 92 KB

A simple, modern, responsive and readable HTML template for your APIs documentations.

Home Page: https://floriannicolas.github.io/API-Documentation-HTML-Template/

License: MIT License

JavaScript 8.00% CSS 34.50% HTML 57.49%

api-documentation-html-template's Introduction

API Documentation HTML Template

A simple, modern and readable HTML template for APIs documentations

You can take a look with this DEMO.
Or this other One Content Column DEMO.

Current version : 1.0.5

What's new in the latest version :

  • Fix list on 3 content columns <ul> and <ol>.
  • Removed jQuery usage to vanilla js.
  • Update of css fonts.
  • Fix menu with long text.
  • Updated Google Font call.
  • Removed usage of Roboto Condensed font.
  • Updated menu data-target to use content.
  • Added .central-overflow-x util class to avoid overflows.
  • Added .break-word util class to avoir overflows without adding a scrollbar.
  • Added optional Version & Last updated infos
  • Added responsive menu with burger icon menu button.

Credits

  • Google Font (Roboto|Source+Code+Pro)
  • Highlight.js 9.8.0
  • A Creative Common logo: platform by Emily van den Heever from the Noun Project.

How to use it

This is a simple HTML template, do whatever you want with this !

To use One Content Column Version, don't forget to add one-content-column-version css class to <body> like in one-content-column.html file.

Utils CSS class

If you have an element in central column that overflow on third column, you can add it central-overflow-x css class to prevent it.

Example:

<table class="central-overflow-x">...<table>

If you doesn't want a scrollbar, you can use break-word css class to prevent it.

Example:

<code class="higlighted break-word">http://api.westeros.com/with-a-very-very-very-very-very-long-end-point-url/get<table>

Contributors

Special thanks to TheStami for his contribution creating One Content Column version !

Contribute

We're always looking for:

  • Bug reports, especially those for aspects with a reduced test case
  • Pull requests for features, spelling errors, clarifications, etc.
  • Ideas for enhancements

api-documentation-html-template's People

Contributors

floriannicolas avatar thestami-zz avatar florian-corellis 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.