Skip to content

Commit 5a8917f

Browse files
aksakalliaksakalli
committed
making bootwatch theme option configurable
1 parent 59a1fe8 commit 5a8917f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+19286
-58
lines changed

‎_config.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Site settings
22
title: Jekyll Doc Theme
33
email: your-email@domain.com
4-
description: >
4+
description: >
55
Jekyll Template for Project Websites
66
providing documentation and blog post pages.
77
@@ -10,6 +10,10 @@ url: https://aksakalli.github.io/jekyll-doc-theme # the base hostname & protocol
1010
git_address: https://github.com/aksakalli/jekyll-doc-theme
1111
git_edit_address: https://github.com/aksakalli/jekyll-doc-theme/blob/gh-pages
1212

13+
# theme options from https://bootswatch.com/
14+
# comment out this to use default Bootstrap
15+
bootwatch: paper
16+
1317
# Build settings
1418
markdown: kramdown
1519
highlighter: rouge

‎_data/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
- title: Getting Started
22
docs:
33
- home
4+
- themes
45
- customization
56

67
- title: Examples

‎_docs/customization.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,11 @@ title: Customization
33
permalink: /docs/customization/
44
---
55

6-
This template uses [bootstrap-sass](https://github.com/twbs/bootstrap-sass) with [bootwatch paper theme](https://bootswatch.com/paper/)'s custom sass variables.
7-
You can change any kind of properties such as font size, color set and etc. in `_sass/_variables.scss` file.
6+
This template uses [bootstrap-sass](https://github.com/twbs/bootstrap-sass) along with [bootwatch themes](https://bootswatch.com/).
7+
You can create your own theme by writing your own `sass` files.
8+
9+
Create a new a theme folder like `_sass/bootwatch/custom` and set your `bootwatch` variables in `_config.yml` to `custom`:
10+
11+
```yaml
12+
bootwatch: custom
13+
```

‎_docs/themes.md

Lines changed: 248 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,248 @@
1+
---
2+
title: Themes
3+
permalink: /docs/themes/
4+
---
5+
6+
By default, this website uses `paper` theme, but you can change it to another [bootwatch theme](https://bootswatch.com/) by setting
7+
`bootwatch` variable in `_config.yml` file.
8+
(Don't forget to restart `Jekyll` if you are running locally because the configuration is not re-read upon change.)
9+
10+
<div class="row">
11+
12+
<div class="col-lg-4 col-sm-6">
13+
<div class="thumbnail">
14+
<div class="image">
15+
<a href="#cerulean/"><img src="https://bootswatch.com/cerulean/thumbnail.png" class="img-responsive" alt="Cerulean"></a>
16+
</div>
17+
<div class="caption">
18+
<h3>Cerulean</h3>
19+
<p>A calm blue sky</p>
20+
</div>
21+
</div>
22+
</div>
23+
24+
<div class="col-lg-4 col-sm-6">
25+
<div class="thumbnail">
26+
<div class="image">
27+
<a href="#cosmo/"><img class="img-responsive" src="https://bootswatch.com/cosmo/thumbnail.png" alt="Cosmo"></a>
28+
</div>
29+
<div class="caption">
30+
<h3>Cosmo</h3>
31+
<p>An ode to Metro</p>
32+
</div>
33+
</div>
34+
</div>
35+
36+
<div class="col-lg-4 col-sm-6">
37+
<div class="thumbnail">
38+
<div class="image">
39+
<a href="#cyborg/"><img class="img-responsive" src="https://bootswatch.com/cyborg/thumbnail.png" alt="Cyborg"></a>
40+
</div>
41+
<div class="caption">
42+
<h3>Cyborg</h3>
43+
<p>Jet black and electric blue</p>
44+
45+
46+
</div>
47+
</div>
48+
</div>
49+
50+
<div class="col-lg-4 col-sm-6">
51+
<div class="thumbnail">
52+
<div class="image">
53+
<a href="#darkly/"><img class="img-responsive" src="https://bootswatch.com/darkly/thumbnail.png" alt="Darkly"></a>
54+
</div>
55+
<div class="caption">
56+
<h3>Darkly</h3>
57+
<p>Flatly in night mode</p>
58+
59+
60+
</div>
61+
</div>
62+
</div>
63+
64+
<div class="col-lg-4 col-sm-6">
65+
<div class="thumbnail">
66+
<div class="image">
67+
<a href="#flatly/"><img class="img-responsive" src="https://bootswatch.com/flatly/thumbnail.png" alt="Flatly"></a>
68+
</div>
69+
<div class="caption">
70+
<h3>Flatly</h3>
71+
<p>Flat and modern</p>
72+
73+
74+
</div>
75+
</div>
76+
</div>
77+
78+
<div class="col-lg-4 col-sm-6">
79+
<div class="thumbnail">
80+
<div class="image">
81+
<a href="#journal/"><img class="img-responsive" src="https://bootswatch.com/journal/thumbnail.png" alt="Journal"></a>
82+
</div>
83+
<div class="caption">
84+
<h3>Journal</h3>
85+
<p>Crisp like a new sheet of paper</p>
86+
87+
88+
</div>
89+
</div>
90+
</div>
91+
92+
<div class="col-lg-4 col-sm-6">
93+
<div class="thumbnail">
94+
<div class="image">
95+
<a href="#lumen/"><img src="https://bootswatch.com/lumen/thumbnail.png" class="img-responsive" alt="Lumen"></a>
96+
</div>
97+
<div class="caption">
98+
<h3>Lumen</h3>
99+
<p>Light and shadow</p>
100+
101+
102+
</div>
103+
</div>
104+
</div>
105+
106+
<div class="col-lg-4 col-sm-6">
107+
<div class="thumbnail">
108+
<div class="image">
109+
<a href="#paper/"><img class="img-responsive" src="https://bootswatch.com/paper/thumbnail.png" alt="Paper"></a>
110+
</div>
111+
<div class="caption">
112+
<h3>Paper</h3>
113+
<p>Material is the metaphor</p>
114+
115+
116+
</div>
117+
</div>
118+
</div>
119+
120+
<div class="col-lg-4 col-sm-6">
121+
<div class="thumbnail">
122+
<div class="image">
123+
<a href="#readable/"><img class="img-responsive" src="https://bootswatch.com/readable/thumbnail.png" alt="Readable"></a>
124+
</div>
125+
<div class="caption">
126+
<h3>Readable</h3>
127+
<p>Optimized for legibility</p>
128+
129+
130+
</div>
131+
</div>
132+
</div>
133+
134+
<div class="col-lg-4 col-sm-6">
135+
<div class="thumbnail">
136+
<div class="image">
137+
<a href="#sandstone/"><img src="https://bootswatch.com/sandstone/thumbnail.png" class="img-responsive" alt="Sandstone"></a>
138+
</div>
139+
<div class="caption">
140+
<h3>Sandstone</h3>
141+
<p>A touch of warmth</p>
142+
143+
144+
</div>
145+
</div>
146+
</div>
147+
148+
<div class="col-lg-4 col-sm-6">
149+
<div class="thumbnail">
150+
<div class="image">
151+
<a href="#simplex/"><img class="img-responsive" src="https://bootswatch.com/simplex/thumbnail.png" alt="Simplex"></a>
152+
</div>
153+
<div class="caption">
154+
<h3>Simplex</h3>
155+
<p>Mini and minimalist</p>
156+
157+
158+
</div>
159+
</div>
160+
</div>
161+
162+
<div class="col-lg-4 col-sm-6">
163+
<div class="thumbnail">
164+
<div class="image">
165+
<a href="#slate/"><img class="img-responsive" src="https://bootswatch.com/slate/thumbnail.png" alt="Slate"></a>
166+
</div>
167+
<div class="caption">
168+
<h3>Slate</h3>
169+
<p>Shades of gunmetal gray</p>
170+
171+
172+
173+
</div>
174+
</div>
175+
</div>
176+
177+
<div class="col-lg-4 col-sm-6">
178+
<div class="thumbnail">
179+
<div class="image">
180+
<a href="#solar/"><img class="img-responsive" src="https://bootswatch.com/solar/thumbnail.png" alt="Solar"></a>
181+
</div>
182+
<div class="caption">
183+
<h3>Solar</h3>
184+
<p>A spin on Solarized</p>
185+
186+
187+
</div>
188+
</div>
189+
</div>
190+
191+
<div class="col-lg-4 col-sm-6">
192+
<div class="thumbnail">
193+
<div class="image">
194+
<a href="#spacelab/"><img class="img-responsive" src="https://bootswatch.com/spacelab/thumbnail.png" alt="Spacelab"></a>
195+
</div>
196+
<div class="caption">
197+
<h3>Spacelab</h3>
198+
<p>Silvery and sleek</p>
199+
200+
201+
</div>
202+
</div>
203+
</div>
204+
205+
<div class="col-lg-4 col-sm-6">
206+
<div class="thumbnail">
207+
<div class="image">
208+
<a href="#superhero/"><img class="img-responsive" src="https://bootswatch.com/superhero/thumbnail.png" alt="Superhero"></a>
209+
</div>
210+
<div class="caption">
211+
<h3>Superhero</h3>
212+
<p>The brave and the blue</p>
213+
214+
215+
</div>
216+
</div>
217+
</div>
218+
219+
<div class="col-lg-4 col-sm-6">
220+
<div class="thumbnail">
221+
<div class="image">
222+
<a href="#united/"><img class="img-responsive" src="https://bootswatch.com/united/thumbnail.png" alt="United"></a>
223+
</div>
224+
<div class="caption">
225+
<h3>United</h3>
226+
<p>Ubuntu orange and unique font</p>
227+
228+
229+
</div>
230+
</div>
231+
</div>
232+
233+
<div class="col-lg-4 col-sm-6">
234+
<div class="thumbnail">
235+
<div class="image">
236+
<a href="#yeti/"><img class="img-responsive" src="https://bootswatch.com/yeti/thumbnail.png" alt="Yeti"></a>
237+
</div>
238+
<div class="caption">
239+
<h3>Yeti</h3>
240+
<p>A friendly foundation</p>
241+
242+
243+
</div>
244+
</div>
245+
</div>
246+
247+
248+
</div>

‎_includes/head.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99

1010
<link rel="stylesheet" href="{{ "/css/main.css" | prepend: site.baseurl }}">
1111
<link rel="stylesheet" href="{{ "/css/font-awesome.min.css" | prepend: site.baseurl }}">
12-
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:400,300,300italic,400italic,500" type="text/css">
13-
1412

1513
<link rel="shortcut icon" href="{{ "/favicon.ico?1" | prepend: site.baseurl }}">
1614
{% seo %}

‎_includes/topnav.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<span class="icon-bar"></span>
99
</button>
1010
<a class="navbar-brand" href="{{ site.baseurl }}/">
11-
<span><img src="{{site.baseurl}}/img/logonav.png" style="margin-top: -14px; width:40px;"></span> {{ site.title }}
11+
<span><img src="{{site.baseurl}}/img/logonav.png"></span> {{ site.title }}
1212
</a>
1313
</div>
1414
<div id="navbar" class="collapse navbar-collapse">

‎_sass/bootswatch/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2013 Thomas Park
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

0 commit comments

Comments
 (0)