1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
.. title: Creating a Theme
.. slug: creating-a-theme
.. date: 2012/03/13 12:00
.. tags:
.. link:
.. description:
Creating A Theme From Scratch (Almost)
======================================
There is some documentation about creating themes for Nikola, but maybe a tutorial is also a useful way
to explain it. So, here it is. I'll explain how to create a theme (almost) from scratch. All themes
in Nikola must inherit from the ``base`` theme. In this case, we will inherit from ``bootstrap``
so we get good support for slides and galleries.
I will try to create a theme that looks like `Vinicius Massuchetto's Monospace Theme <http://wordpress.org/themes/monospace>`_.
.. TEASER_END
Starting The Theme
------------------
First we will create a testing site::
$ nikola init --demo monospace-site
A new site with some sample data has been created at monospace-site.
See README.txt in that folder for more information.
$ cd monospace-site/
Our theme will inherit from the ``bootstrap`` theme, which is full-featured but boring.
::
$ mkdir themes
$ mkdir themes/monospace
$ echo bootstrap > themes/monospace/parent
The next step is to make the testing site use this new theme, by editing ``conf.py`` and
changing the ``THEME`` option::
# Name of the theme to use. Themes are located in themes/theme_name
THEME = 'monospace'
Now we can already build and test the site::
$ nikola build && nikola serve
.. figure:: http://ralsina.com.ar/galleries/monospace-tut/monospace-1.png
:height: 400px
This is the default "bootstrap" theme.
Of course, the page layout is completely different from what we want. To fix that, we need to
get into templates.
Templates: Page Layout
----------------------
The general page layout for the theme is done by the ``base.tmpl`` template, which is done using
`Mako <http://www.makotemplates.org/>`_. This is bootstrap's ``base.tmpl``, it's not very big:
.. code-block:: mako
## -*- coding: utf-8 -*-
<%namespace name="base" file="base_helper.tmpl" import="*" />
<%namespace name="bootstrap" file="bootstrap_helper.tmpl" import="*" />
${set_locale(lang)}
<!DOCTYPE html>
<html% if comment_system == 'facebook': xmlns:fb="http://ogp.me/ns/fb#" %endif lang="${lang}">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
${bootstrap.html_head()}
<%block name="extra_head">
</%block>
${extra_head_data}
</head>
<body>
<!-- Menubar -->
<div class="navbar navbar-fixed-top" id="navbar">
<div class="navbar-inner">
<div class="container">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="${abs_link('/')}">
${blog_title}
</a>
<!-- Everything you want hidden at 940px or less, place within here -->
<div class="nav-collapse collapse">
<ul class="nav">
${bootstrap.html_navigation_links()}
</ul>
%if search_form:
${search_form}
%endif
<ul class="nav pull-right">
<%block name="belowtitle">
%if len(translations) > 1:
<li>${base.html_translations()}</li>
%endif
</%block>
% if not hide_sourcelink:
<li><%block name="sourcelink"></%block></li>
%endif
</ul>
</div>
</div>
</div>
</div>
<!-- End of Menubar -->
<div class="container-fluid" id="container-fluid">
<!--Body content-->
<div class="row-fluid">
<div class="span2"></div>
<div class="span8">
<%block name="content"></%block>
</div>
</div>
<!--End of body content-->
</div>
<div class="footerbox">
${content_footer}
</div>
${bootstrap.late_load_js()}
${base.html_social()}
<script type="text/javascript">jQuery("a.image-reference").colorbox({rel:"gal",maxWidth:"100%",maxHeight:"100%",scalePhotos:true});
$(window).on('hashchange', function(){
if (location.hash && $(location.hash)[0]) {
$('body').animate({scrollTop: $(location.hash).offset().top - $('#navbar').outerHeight(true)*1.2 }, 1);
}
});
$(document).ready(function(){$(window).trigger('hashchange')});
</script>
<%block name="extra_js"></%block>
${body_end}
</body>
It's basically a HTML document with some placeholders to be replaced with actual content, configuration options, and some helper functions.
For example, the ``html_head`` helper can be used to add CSS or JS files in all document's ``head`` tags.
Monospace is a two-column-with-footer layout, so let's copy the basics from its HTML and see what happens:
.. code-block:: mako
## -*- coding: utf-8 -*-
<%namespace name="base" file="base_helper.tmpl" import="*"/>
<%namespace name="bootstrap" file="bootstrap_helper.tmpl" import="*" />
${set_locale(lang)}
<!DOCTYPE html>
<html lang="${lang}">
<head>
${bootstrap.html_head()}
<%block name="extra_head">
</%block>
${extra_head_data}
</head>
<body class="home blog">
<div id="wrap" style="width:850px">
<div id="container" style="width:560px">
<%block name="content"></%block>
</div>
<div id="sidebar">
<!--Sidebar content-->
<h1 id="blog-title">
<a href="${abs_link('/')}" title="${blog_title}">${blog_title}</a>
</h1>
<%block name="belowtitle">
%if len(translations) > 1:
<small>
${(messages("Also available in"))}:
${base.html_translations()}
</small>
%endif
</%block>
<ul class="unstyled">
<li>${license}
${base.html_social()}
${bootstrap.html_navigation_links()}
<li>${search_form}
</ul>
</div>
<div id="footer">
${content_footer}
</div>
</div>
${bootstrap.late_load_js()}
<script type="text/javascript">jQuery("a.image-reference").colorbox({rel:"gal",maxWidth:"100%",maxHeight:"100%",scalePhotos:true});</script>
<%block name="extra_js"></%block>
${body_end}
</body>
.. figure:: http://ralsina.com.ar/galleries/monospace-tut/monospace-2.png
Yikes!
This will get better quickly once we add some CSS
Base CSS
--------
The orphan theme includes just a little styling, specifically ``rest.css`` so
the reStructuredText output looks reasonable, and ``code.css`` for code snippets.
It also includes an empty ``assets/css/theme.css`` where you can add your own CSS.
For example, this is taken from the original monospace theme, except for the last
few selectors:
.. code-block:: css
body { margin:0px; padding:20px 0px; text-align:center; font-family:Monospace; color:#585858; }
.post { margin:0px 0px 30px 0px; padding:0px 0px 30px 0px; border-bottom:1px dotted #C8C8C8; }
.meta { margin:10px; padding:15px; background:#EAEAEA; clear:both; }
#footer { text-align:center; clear:both; margin:30px 0px 0px 0px; padding:30px 0px 0px 0px; border-top:1px dotted #C8C8C8; }
#wrap { margin:0px auto; text-align:left; font-size: 13px; line-height: 1.4; }
#container { float:right; }
#sidebar { overflow:hidden; clear:left; text-align:right; width:250px; height:auto; padding:0px 15px 0px 0px; border-right:1px dotted #C8C8C8; }
#sidebar li { list-style-type:none; }
#sidebar > li { margin:20px 0px; }
#sidebar h1 { border-bottom:1px dotted #C8C8C8; }
#sidebar .description { display:block; width:100%; height:auto; margin:0px 0px 10px 0px; }
h1, h2, h3, h4, h5, h6, h7 { margin:0px; text-transform:uppercase; }
h4, h5, h6 { font-size:14px; }
#blog-title { margin-top: 0; line-height:48px;}
.literal-block {padding: .5em;}
div.sidebar, div.admonition, div.attention, div.caution, div.danger, div.error, div.hint, div.important, div.note, div.tip, div.warning {
/* Issue 277 */
border: 1px solid #aaa;
border-radius: 5px;
width: 100%;
}
ul.breadcrumb > li:before {
content: " / ";
}
This will (after we rebuild it) make the site looks different of course, and getting closer to our goal:
.. figure:: http://ralsina.com.ar/galleries/monospace-tut/monospace-3.png
:height: 400px
Monospaced allright.
If you compare it to `the original <http://wp-themes.com/monospace/>`_, however, you will see that the layout of
the posts themselves is different, and that was not described in ``base.tmpl`` at all. But if you look, you'll see that
there is a placeholder called content: ``<%block name="content"></%block>``
That's because ``base.tmpl`` defines the *base* layout. The layout of more specific pages, like "the page that shows
a list of posts" is defined in the other templates. Specifically, this is defined in ``index.tmpl``.
It turns out ``bootstrap`` doesn' have one of those! That's because it inherits that template from ``base``:
.. code-block:: mako
## -*- coding: utf-8 -*-
<%namespace name="helper" file="index_helper.tmpl"/>
<%namespace name="comments" file="comments_helper.tmpl"/>
<%inherit file="base.tmpl"/>
<%block name="content">
% for post in posts:
<div class="postbox">
<h1><a href="${post.permalink()}">${post.title()}</a>
<small>
${messages("Posted")}: <time class="published" datetime="${post.date.isoformat()}">${post.formatted_date(date_format)}</time>
</small></h1>
<hr>
${post.text(teaser_only=index_teasers)}
% if not post.meta('nocomments'):
${comments.comment_link(post.permalink(), post.base_path)}
% endif
</div>
% endfor
${helper.html_pager()}
${comments.comment_link_script()}
${helper.mathjax_script(posts)}
</%block>
So, let's tweak that to be closer to the original. We put the post's metadata in a
box, add links for the posts tags, move the date there, etc.
.. code-block:: mako
## -*- coding: utf-8 -*-
<%namespace name="helper" file="index_helper.tmpl"/>
<%namespace name="disqus" file="disqus_helper.tmpl"/>
<%inherit file="base.tmpl"/>
<%block name="content">
% for post in posts:
<div class="postbox">
<h1><a href="${post.permalink()}">${post.title()}</a></h1>
<div class="meta" style="background-color: rgb(234, 234, 234); ">
<span class="authordate">
${messages("Posted")}: ${post.formatted_date(date_format)}
</span>
<br>
<span class="tags">Tags:
%if post.tags:
%for tag in post.tags:
<a class="tag" href="${_link('tag', tag)}"><span>${tag}</span></a>
%endfor
%endif
</span>
</div>
${post.text(teaser_only=index_teasers)}
% if not post.meta('nocomments'):
${disqus.html_disqus_link(post.permalink()+"#disqus_thread", post.base_path)}
% endif
</div>
% endfor
${helper.html_pager()}
${disqus.html_disqus_script()}
</%block>
.. figure:: http://ralsina.com.ar/galleries/monospace-tut/monospace-4.png
:height: 400px
Close enough!
Then if we click on the post title, we will see some broken details in the metadata that can be fixed in ``post.tmpl``, and so on.
.. code-block:: mako
## -*- coding: utf-8 -*-
<%namespace name="helper" file="post_helper.tmpl"/>
<%namespace name="disqus" file="disqus_helper.tmpl"/>
<%inherit file="base.tmpl"/>
<%block name="extra_head">
${helper.twitter_card_information(post)}
% if post.meta('keywords'):
<meta name="keywords" content="${post.meta('keywords')|h}"/>
% endif
</%block>
<%block name="content">
<div class="post">
${helper.html_title()}
<div class="meta" style="background-color: rgb(234, 234, 234); ">
<span class="authordate">
${messages("Posted")}: ${post.formatted_date(date_format)}
% if not post.meta('password'):
[<a href="${post.source_link()}" id="sourcelink">${messages("Source")}</a>]
% endif
</span>
<br>
%if post.tags:
<span class="tags">${messages("Tags")}:
%for tag in post.tags:
<a class="tag" href="${_link('tag', tag)}"><span>${tag}</span></a>
%endfor
</span>
<br>
%endif
<span class="authordate">
${helper.html_translations(post)}
</span>
</div>
${post.text()}
${helper.html_pager(post)}
% if not post.meta('nocomments'):
${disqus.html_disqus(post.permalink(absolute=True), post.title(), post.base_path)}
% endif
</div>
</%block>
.. figure:: http://ralsina.com.ar/galleries/monospace-tut/monospace-5.png
:height: 400px
Details, details.
The demo site exercises most of the features in Nikola, so if you make it look good, your site probably will look good too.
This monospace theme is included with nikola, if you want to use it or play with it.
|
