Skip to content

Commit

Permalink
fuck yeah, docs!
Browse files Browse the repository at this point in the history
* no separate repository
* no complicated file structure
* local documentation when offline
* auto-deployment via github-hook
  • Loading branch information
rubiii committed Apr 28, 2013
1 parent 1b6dfb9 commit 5654f6c
Show file tree
Hide file tree
Showing 7 changed files with 388 additions and 167 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
.DS_Store
.yardoc
doc
rdox
coverage
tmp
*.rbc
Expand Down
53 changes: 53 additions & 0 deletions docs/assets/layout.slim
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
doctype html
html
head
meta charset='utf-8'
title Savon (Heavy metal SOAP client) - #{title}
link href='http://yandex.st/highlightjs/7.3/styles/solarized_light.min.css' rel='stylesheet'
link href='http://cdnjs.cloudflare.com/ajax/libs/font-awesome/3.0.2/css/font-awesome.min.css' rel='stylesheet'
link href='./screen.css' rel='stylesheet'
link href='http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic' rel='stylesheet'
link href='http://fonts.googleapis.com/css?family=Inconsolata' rel='stylesheet'

body
- unless index_page
nav
h1 Savon
h2 Heavy metal SOAP client
ul#toc== toc

section class=page_name
header
h1
a href='/' Savon
h2 Heavy metal SOAP client

ul#links
li
a href='https://github.com/savonrb/savon' class='ico'
i class='icon-github icon-large'
| Source
li
a href='http://rubygems.org/gems/savon' class='ico'
i class='icon-cloud-download icon-large'
| Releases
li
a href='https://groups.google.com/forum/#!forum/savonrb' class='ico'
i class='icon-comments icon-large'
| Community
li
a href='https://twitter.com/savonrb' class='ico'
i class='icon-twitter icon-large'
| Updates

- unless index_page
h1= title

== page


script src='http://yandex.st/highlightjs/7.3/highlight.min.js'
script src='http://yandex.st/highlightjs/7.3/languages/xml.min.js'

javascript:
hljs.initHighlightingOnLoad();
157 changes: 157 additions & 0 deletions docs/assets/screen.sass
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
*
margin: 0
padding: 0

body, p,
h1, h2, h3, h4, h5, h6
font-family: "Open Sans", sans-serif

h1, h2, h3, h4, h5, h6
font-weight: 300

body
color: #333
background: #fff
font-size: 16px
line-height: 24px

a
color: #B58900
text-decoration: underline

&.ico
text-decoration: none

&:hover
color: #859900
text-decoration: none

h1 a, h2 a
text-decoration: none

nav
position: fixed
width: 320px
padding: 65px 0 0 30px
z-index: 1

h1, h2
margin-left: 25px

h1
color: #B58900

h2
font-size: 13px
color: #859900

#toc
color: #bbb
margin: 40px 0 0 25px

section.index
margin-left: 0
border-left: 0

header
margin-bottom: 30px

section
position: relative
margin: 0 170px 0 320px
padding-bottom: 70px
border-left: 1px solid #E3E3E3
min-height: 900px
z-index: 10

header
border-bottom: 1px solid #f4f4f4
padding: 70px 0 50px 70px

h1
color: #B58900
font-size: 110px
line-height: 110px
margin-left: -3px
h2
color: #859900
font-size: 24px
line-height: 24px

#links
list-style: none
margin: 50px 0 0 -4px
padding: 0

li
display: inline
margin-right: 20px
i
color: #93a1a1

a:hover i
color: #859900

a.ico
color: #93a1a1

&:hover
color: #859900

i
padding-right: 3px

p, ol, ul
padding-left: 70px
margin-bottom: 24px

ol, ul
list-style-position: inside

> h1
color: #B58900
font-size: 40px
line-height: 40px
padding: 70px 0 50px 70px

> h2
color: #859900
font-size: 40px
line-height: 40px
border-top: 1px solid #f4f4f4
padding: 70px 0 50px 70px
margin-top: 110px

&.index
padding-top: 0
border-top: 0
margin-top: 70px

h3
color: #859900
font-size: 30px
line-height: 30px
padding: 70px 0 30px 70px
margin-bottom: 50px
border-bottom: 1px solid #f4f4f4

h4
color: #859900
font-size: 18px
line-height: 18px
padding: 30px 0 30px 70px

code
font: 15px/18px "Inconsolata", Monaco, "Courier New", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", monospace
background: #f4f4f4
border-bottom: 1px solid #e8e8e8
border-radius: 2px
padding: 3px 8px

pre
padding-left: 70px
margin: 30px 0

code
overflow: scroll
padding: 15px 20px

0 comments on commit 5654f6c

Please sign in to comment.