Skip to content

Commit

Permalink
Version 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Florian Nicolas authored and Florian Nicolas committed Dec 26, 2016
1 parent 4969d36 commit 4d9bd83
Show file tree
Hide file tree
Showing 7 changed files with 682 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
# API-Documentation-HTML-Template
A simple, modern and readable HTML template for APIs documentations
# API Documentation HTML Template

### A simple, modern and readable HTML template for APIs documentations


## Current version : 1.0.0

This template use :

* jQuery.js
* Highlight.js
* Google font
* A Creative Common logo: platform by Emily van den Heever from the Noun Project


## 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
36 changes: 36 additions & 0 deletions css/hightlightjs-dark.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.hljs {
display:block;
overflow-x:auto;
padding:0.5em;
background:#323F4C;
}
.hljs {
color:#fff;
}
.hljs-strong,.hljs-emphasis {
color:#a8a8a2
}
.hljs-bullet,.hljs-quote,.hljs-link,.hljs-number,.hljs-regexp,.hljs-literal {
color:#6896ba
}
.hljs-code,.hljs-selector-class {
color:#a6e22e
}
.hljs-emphasis {
font-style:italic
}
.hljs-keyword,.hljs-selector-tag,.hljs-section,.hljs-attribute,.hljs-name,.hljs-variable {
color:#cb7832
}
.hljs-params {
color:#b9b9b9
}
.hljs-string {
color:#6a8759
}
.hljs-subst,.hljs-type,.hljs-built_in,.hljs-builtin-name,.hljs-symbol,.hljs-selector-id,.hljs-selector-attr,.hljs-selector-pseudo,.hljs-template-tag,.hljs-template-variable,.hljs-addition {
color:#e0c46c
}
.hljs-comment,.hljs-deletion,.hljs-meta {
color:#7f7f7f
}
326 changes: 326 additions & 0 deletions css/style.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,326 @@
@charset "utf-8";

/* RESET
----------------------------------------------------------------------------------------*/

html, body, div, span, applet, object, iframe,
h1, h2, h3, h4, h5, h6, p, blockquote, pre,
a, abbr, acronym, address, big, cite, code,
del, dfn, em, ins, kbd, q, s, samp,
small, strike, strong, sub, sup, tt, var,
b, u, i, center,
dl, dt, dd, ol, ul, li,
fieldset, form, label, legend,
table, caption, tbody, tfoot, thead, tr, th, td,
article, aside, canvas, details, embed,
figure, figcaption, footer, hgroup,
menu, nav, output, ruby, section, summary,
time, mark, audio, video {
margin: 0;
padding: 0;
border: 0;
font-size:100%;
font: inherit;
vertical-align: baseline;
}
article, aside, details, figcaption, figure, footer, header, hgroup, menu, nav, section {
display: block;
}
img, embed, object, video { max-width: 100%; }
.ie6 img.full, .ie6 object.full, .ie6 embed, .ie6 video { width: 100%; }

/* BASE
----------------------------------------------------------------------------------------*/

*{
-webkit-transition: all 0.3s ease;
-moz-transition: all 0.3s ease;
-o-transition: all 0.3s ease;
-ms-transition: all 0.3s ease;
transition: all 0.3s ease;
}
html,
body{
position:relative;
min-height: 100%;
height: 100%;
-webkit-backface-visibility: hidden;
font-family: 'Roboto', sans-serif;
}
strong{
font-weight: 500;
}
i{
font-style: italic;
}
.overflow-hidden{
position: relative;
overflow: hidden;
}
.content a{
color: #00a8e3;
text-decoration: none;
}
.content a:hover{
text-decoration: underline;
}
.scroll-to-link{
cursor: pointer;
}
p{
font-size: 14px;
color: #777A7A;
margin-bottom: 16px;
line-height: 1.6;
font-weight: 300;
}
.content h1:first-child{
font-size: 1.333em;
color: #034c8f;
padding-top: 2.5em;
text-transform: uppercase;
border-top: 1px solid rgba(255,255,255,0.3);
border-top-width: 0;
margin-top: 0;
margin-bottom: 1.3em;
clear: both;
font-family: 'Roboto Condensed', sans-serif;
}
code,
pre{
font-family: 'Source Code Pro', monospace;
}
.higlighted{
background-color: rgba(0,0,0,0.05);
padding: 3px;
border-radius: 3px;
}

/* LEFT-MENU
----------------------------------------------------------------------------------------*/

.left-menu{
position: fixed;
z-index: 3;
top: 0;
left: 0;
bottom: 0;
width: 300px;
box-sizing: border-box;
background-color: #f4f5f8;
overflow-x: hidden;
font-size: 18px;
}
.content-logo{
position: relative;
display: block;
width: 100%;
box-sizing: border-box;
padding: 1.425em 18.5% 1.425em 11.5%;
}
.content-logo img{
display: inline-block;
max-width: 70%;
}
.content-logo span{
display: inline-block;
margin-left: 10px;
vertical-align: top;
color: #323F4C;
font-size: 1.1em;
font-family: 'Roboto Condensed', sans-serif;
}
.content-menu{
margin: 2em auto 2em;
padding: 0 0 100px;
font-family: 'Roboto Condensed', sans-serif;
}
.content-menu ul{
list-style: none;
margin: 0;
padding: 0;
line-height: 28px;
}
.content-menu ul li{
list-style: none;
margin: 0;
padding: 0;
line-height: 42px;
}
.content-menu ul li:hover,
.content-menu ul li.active{
background-color:#DCDEE9;
}
.content-menu ul li:hover a,
.content-menu ul li.active a{
color: #00a8e3;
}
.content-menu ul li a{
padding: 0.5em 13.25% 0em;
color: #777A7A;
letter-spacing: 0.025em;
line-height: 1.2;
text-transform: capitalize;
}

/* CONTENT-PAGE
----------------------------------------------------------------------------------------*/

.content-page {
position: relative;
box-sizing: border-box;
margin-left: 300px;
z-index: 2;
background-color: #fff;
min-height: 100%;
padding-bottom: 1px;
}
.content-code{
width: 50%;
position: absolute;
right: 0;
top: 0;
bottom: 0;
background-color: #323f4c;
border-color: #323f4c;
}
.content {
position: relative;
z-index: 30;
}
.content h1,
.content h2,
.content h3,
.content h4,
.content h5,
.content h6,
.content p,
.content table,
.content ul,
.content ol,
.content aside,
.content dl {
margin-right: 50%;
padding: 0 28px;
box-sizing: border-box;
display: block;
max-width: 680px;
}
.content h2,
.content h3,
.content h4,
.content h5,
.content h6 {
font-size: 15px;
margin-top: 2.5em;
margin-bottom: 0.8em;
color: #034c8f;
text-transform: uppercase;
font-family: 'Roboto Condensed', sans-serif;
}
.content h2{
font-size: 1.333em;
}
.content h4{
color: #00a8e3;
margin-top: 0;
text-transform: none;
font-size: 14px;
margin-bottom: 0.2em;
}
.content-page .content p,
.content-page .content pre {
max-width: 680px;
}
.content pre,
.content blockquote {
background-color: #323f4c;
border-color: #323f4c;
color: #fff;
padding: 0 28px 2em;
margin: 0;
width: 50%;
float: right;
clear: right;
box-sizing: border-box;
}
.content pre code, .content pre {
font-size: 12px;
line-height: 1.5;
}
.content blockquote,
.content pre,
.content pre code{
padding-top: 0;
margin-top: 0;
}
.content pre code{
margin-top: -2em;
}
.content table {
font-size: 0.825em;
margin-bottom: 1.5em;
border-collapse: collapse;
border-spacing: 0;
}
.content table tr:last-child {
border-bottom: 1px solid #ccc;
}
.content table th {
font-size: 0.925em;
padding: 5px 18px 5px 0;
border-bottom: 1px solid #ccc;
vertical-align: bottom;
text-align: left;
line-height: 1.6;
}
.content table td {
padding: 5px 18px 5px 0;
text-align: left;
vertical-align: top;
line-height: 1.6;
font-family: 'Roboto', sans-serif;
font-weight: 300;
color: #777A7A;
}
/* RESPONSIVE
----------------------------------------------------------------------------------------*/

@media only screen and (max-width:980px){
.content h1, .content h2, .content h3, .content h4, .content h5, .content h6, .content p, .content table, .content ul, .content ol, .content aside, .content dl {
margin-right: 0;
}
.content-code{
display: none;
}
.content pre, .content blockquote {
margin: 20px 0;
padding: 28px;
display: block;
width: auto;
float: none;
}
.content pre code {
margin-top: 0;
}
}

@media only screen and (max-width:680px){
.left-menu{
position: relative;
width: auto;
}
.left-menu .content-menu{
display: none;
}
.content-page{
margin-left: 0;
}
}

/* BROWSER AND NON-SEMANTIC STYLING
----------------------------------------------------------------------------------------*/

.cf:before, .cf:after { content: ""; display: block; }
.cf:after { clear: both; }
.ie6 .cf { zoom: 1 }
Binary file added images/logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 4d9bd83

Please sign in to comment.