Skip to content

Commit 5de97eb

Browse files
tedrektedrek
committed
Basic conversion of wiki to jekyll documentation
1 parent 3823b2e commit 5de97eb

File tree

9 files changed

+587
-1
lines changed

9 files changed

+587
-1
lines changed

‎.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
*~
2-
.DS_Store
2+
.DS_Store
3+
_site/

‎Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
source 'https://rubygems.org'
2+
gem 'github-pages'

‎Gemfile.lock

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
RedCloth (4.2.9)
5+
activesupport (4.2.5)
6+
i18n (~> 0.7)
7+
json (~> 1.7, >= 1.7.7)
8+
minitest (~> 5.1)
9+
thread_safe (~> 0.3, >= 0.3.4)
10+
tzinfo (~> 1.1)
11+
addressable (2.3.8)
12+
blankslate (2.1.2.4)
13+
classifier-reborn (2.0.4)
14+
fast-stemmer (~> 1.0)
15+
coffee-script (2.4.1)
16+
coffee-script-source
17+
execjs
18+
coffee-script-source (1.10.0)
19+
colorator (0.1)
20+
ethon (0.8.0)
21+
ffi (>= 1.3.0)
22+
execjs (2.6.0)
23+
faraday (0.9.2)
24+
multipart-post (>= 1.2, < 3)
25+
fast-stemmer (1.0.2)
26+
ffi (1.9.10)
27+
gemoji (2.1.0)
28+
github-pages (40)
29+
RedCloth (= 4.2.9)
30+
github-pages-health-check (= 0.5.3)
31+
jekyll (= 2.4.0)
32+
jekyll-coffeescript (= 1.0.1)
33+
jekyll-feed (= 0.3.1)
34+
jekyll-gist (= 1.4.0)
35+
jekyll-mentions (= 0.2.1)
36+
jekyll-paginate (= 1.1.0)
37+
jekyll-redirect-from (= 0.8.0)
38+
jekyll-sass-converter (= 1.3.0)
39+
jekyll-sitemap (= 0.9.0)
40+
jemoji (= 0.5.0)
41+
kramdown (= 1.9.0)
42+
liquid (= 2.6.2)
43+
maruku (= 0.7.0)
44+
mercenary (~> 0.3)
45+
pygments.rb (= 0.6.3)
46+
rdiscount (= 2.1.8)
47+
redcarpet (= 3.3.3)
48+
terminal-table (~> 1.4)
49+
github-pages-health-check (0.5.3)
50+
addressable (~> 2.3)
51+
net-dns (~> 0.8)
52+
public_suffix (~> 1.4)
53+
typhoeus (~> 0.7)
54+
html-pipeline (1.9.0)
55+
activesupport (>= 2)
56+
nokogiri (~> 1.4)
57+
i18n (0.7.0)
58+
jekyll (2.4.0)
59+
classifier-reborn (~> 2.0)
60+
colorator (~> 0.1)
61+
jekyll-coffeescript (~> 1.0)
62+
jekyll-gist (~> 1.0)
63+
jekyll-paginate (~> 1.0)
64+
jekyll-sass-converter (~> 1.0)
65+
jekyll-watch (~> 1.1)
66+
kramdown (~> 1.3)
67+
liquid (~> 2.6.1)
68+
mercenary (~> 0.3.3)
69+
pygments.rb (~> 0.6.0)
70+
redcarpet (~> 3.1)
71+
safe_yaml (~> 1.0)
72+
toml (~> 0.1.0)
73+
jekyll-coffeescript (1.0.1)
74+
coffee-script (~> 2.2)
75+
jekyll-feed (0.3.1)
76+
jekyll-gist (1.4.0)
77+
octokit (~> 4.2)
78+
jekyll-mentions (0.2.1)
79+
html-pipeline (~> 1.9.0)
80+
jekyll (~> 2.0)
81+
jekyll-paginate (1.1.0)
82+
jekyll-redirect-from (0.8.0)
83+
jekyll (>= 2.0)
84+
jekyll-sass-converter (1.3.0)
85+
sass (~> 3.2)
86+
jekyll-sitemap (0.9.0)
87+
jekyll-watch (1.3.0)
88+
listen (~> 3.0)
89+
jemoji (0.5.0)
90+
gemoji (~> 2.0)
91+
html-pipeline (~> 1.9)
92+
jekyll (>= 2.0)
93+
json (1.8.3)
94+
kramdown (1.9.0)
95+
liquid (2.6.2)
96+
listen (3.0.5)
97+
rb-fsevent (>= 0.9.3)
98+
rb-inotify (>= 0.9)
99+
maruku (0.7.0)
100+
mercenary (0.3.5)
101+
mini_portile2 (2.0.0)
102+
minitest (5.8.3)
103+
multipart-post (2.0.0)
104+
net-dns (0.8.0)
105+
nokogiri (1.6.7.1)
106+
mini_portile2 (~> 2.0.0.rc2)
107+
octokit (4.2.0)
108+
sawyer (~> 0.6.0, >= 0.5.3)
109+
parslet (1.5.0)
110+
blankslate (~> 2.0)
111+
posix-spawn (0.3.11)
112+
public_suffix (1.5.3)
113+
pygments.rb (0.6.3)
114+
posix-spawn (~> 0.3.6)
115+
yajl-ruby (~> 1.2.0)
116+
rb-fsevent (0.9.6)
117+
rb-inotify (0.9.5)
118+
ffi (>= 0.5.0)
119+
rdiscount (2.1.8)
120+
redcarpet (3.3.3)
121+
safe_yaml (1.0.4)
122+
sass (3.4.20)
123+
sawyer (0.6.0)
124+
addressable (~> 2.3.5)
125+
faraday (~> 0.8, < 0.10)
126+
terminal-table (1.5.2)
127+
thread_safe (0.3.5)
128+
toml (0.1.2)
129+
parslet (~> 1.5.0)
130+
typhoeus (0.8.0)
131+
ethon (>= 0.8.0)
132+
tzinfo (1.2.2)
133+
thread_safe (~> 0.1)
134+
yajl-ruby (1.2.1)
135+
136+
PLATFORMS
137+
ruby
138+
139+
DEPENDENCIES
140+
github-pages
141+
142+
BUNDLED WITH
143+
1.10.6

‎_config.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Jekyll is only used for documentation at this point
2+
layouts_dir: ./documentation/_layouts
3+
data_dir: ./documentation/_data
4+
includes_dir: ./documentation/_includes
5+
6+
# Enable Github flavored markdown
7+
kramdown:
8+
input: GFM
9+
hard_wrap: false
10+
11+
# Set default values for documentation
12+
defaults:
13+
-
14+
scope:
15+
path: "documentation"
16+
type: "pages"
17+
values:
18+
layout: "documentation"

‎documentation/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Documentation
3+
---
4+
[back to index](index.html)
5+
6+
# Documentation guide
7+
8+
This documentation is maintained as a
9+
[Github pages](https://help.github.com/articles/using-jekyll-with-pages/)
10+
[Jekyll](jekyllrb.com) site. Individual pages should be markdown
11+
format, when pushed to github these will be automatically converted to
12+
html.
13+
14+
To add a new page add a link to the new page in `index.md`
15+
(remembering that .md files will be converted to .html on
16+
deployment). Then create a new file in this folder of the appropriate name.
17+
18+
In order to be converted all `.md` files must begin with
19+
20+
```
21+
---
22+
title: <some title>
23+
---
24+
```
25+
26+
See the [jekyll documentation](http://jekyllrb.com/docs/home/)
27+
for more information.

‎documentation/_layouts/documentation.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<html>
2+
<head>
3+
<title>{% if page.title %} {{ page.title }} | {% endif %} ATC Documentation</title>
4+
</head>
5+
<body>
6+
{{ content }}
7+
</body>
8+
</html>

0 commit comments

Comments
 (0)