aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 00e77d8212531c41834b953655634bc6139c33f1 (plain)
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
# Nest

Nest is a theme for [Pelican](http://getpelican.com) 3.5, a static site generator written in Python.

I initially created this theme for [my blog](http://www.molivier.com), but now the theme is supposed to be generic enough to have its own repository.

## Screenshots

### Homepage

![Nest Index View](homepage.png)

### Homepage with background

![Nest Article View](homepage-background.png)

Add a background image by configuring `NEST_HEADER_IMAGES` parameter in your pelican.conf. Image should be located in `content/images` directory.

### Article

![Nest Index View](article.png)

### Article with background

![Nest Article View](article-background.png)

Add a background image by adding `Illustration` custom parameter in your markdown article. Image should be located in `content/images` directory.

	Title: Ubuntu Install
	Date: 2015-02-18 16:00
	Category: server
	Tags: ubuntu, kernel
	Slug: ubuntu-install
	Author: Matthieu OLIVIER
	Illustration: background.jpg


## Features

* Featured site header image
* Featured article header image
* **Pygments** syntax highlighting
* **Disqus** support for comments
* **Google Analytics** support
* RSS and Atom feeds

## Settings

Nest template can be customized by adding parameters to your `pelicanconf.py` file. Template specifics parameters are prefixed with template name.

### Pelican.conf example

	# NEST Template
	THEME = 'nest'
	SITESUBTITLE = u'My Awesome Blog'
	# Minified CSS
	NEST_CSS_MINIFY = True
	# Add items to top menu before pages
	MENUITEMS = [('Homepage', '/'),('Categories','/categories.html')]
	# Add header background image from content/images : 'background.jpg'
	NEST_HEADER_IMAGES = ''
	# Footer
	NEST_SITEMAP_COLUMN_TITLE = u'Sitemap'
	NEST_SITEMAP_MENU = [('Archives', '/archives.html'),('Tags','/tags.html'), ('Authors','/authors.html')]
	NEST_SITEMAP_ATOM_LINK = u'Atom Feed'
	NEST_SITEMAP_RSS_LINK = u'RSS Feed'
	NEST_SOCIAL_COLUMN_TITLE = u'Social'
	NEST_LINKS_COLUMN_TITLE = u'Links'
	NEST_COPYRIGHT = u'© blogname 2015'
	# index.html
	NEST_INDEX_HEAD_TITLE = Homepage'
	NEST_INDEX_HEADER_TITLE = u'My Awesome Blog'
	NEST_INDEX_HEADER_SUBTITLE = u'Smashing The Stack For Fun And Profit'
	NEST_INDEX_CONTENT_TITLE = u'Last Posts'
	# archives.html
	NEST_ARCHIVES_HEAD_TITLE = u'Archives'
	NEST_ARCHIVES_HEAD_DESCRIPTION = u'Posts Archives'
	NEST_ARCHIVES_HEADER_TITLE = u'Archives'
	NEST_ARCHIVES_HEADER_SUBTITLE = u'Archives for all posts'
	NEST_ARCHIVES_CONTENT_TITLE = u'Archives'
	# article.html
	NEST_ARTICLE_HEADER_BY = u'By'
	NEST_ARTICLE_HEADER_MODIFIED = u'modified'
	NEST_ARTICLE_HEADER_IN = u'in category'
	# author.html
	NEST_AUTHOR_HEAD_TITLE = u'Posts by'
	NEST_AUTHOR_HEAD_DESCRIPTION = u'Posts by'
	NEST_AUTHOR_HEADER_SUBTITLE = u'Posts archives'
	NEST_AUTHOR_CONTENT_TITLE = u'Posts'
	# authors.html
	NEST_AUTHORS_HEAD_TITLE = u'Author list'
	NEST_AUTHORS_HEAD_DESCRIPTION = u'Author list'
	NEST_AUTHORS_HEADER_TITLE = u'Author list'
	NEST_AUTHORS_HEADER_SUBTITLE = u'Archives listed by author'
	# categories.html
	NEST_CATEGORIES_HEAD_TITLE = u'Categories'
	NEST_CATEGORIES_HEAD_DESCRIPTION = u'Archives listed by category'
	NEST_CATEGORIES_HEADER_TITLE = u'Categories'
	NEST_CATEGORIES_HEADER_SUBTITLE = u'Archives listed by category'
	# category.html
	NEST_CATEGORY_HEAD_TITLE = u'Category Archive'
	NEST_CATEGORY_HEAD_DESCRIPTION = u'Category Archive'
	NEST_CATEGORY_HEADER_TITLE = u'Category'
	NEST_CATEGORY_HEADER_SUBTITLE = u'Category Archive'
	# pagination.html
	NEST_PAGINATION_PREVIOUS = u'Previous'
	NEST_PAGINATION_NEXT = u'Next'
	# period_archives.html
	NEST_PERIOD_ARCHIVES_HEAD_TITLE = u'Archives for'
	NEST_PERIOD_ARCHIVES_HEAD_DESCRIPTION = u'Archives for'
	NEST_PERIOD_ARCHIVES_HEADER_TITLE = u'Archives'
	NEST_PERIOD_ARCHIVES_HEADER_SUBTITLE = u'Archives for'
	NEST_PERIOD_ARCHIVES_CONTENT_TITLE = u'Archives for'
	# tag.html
	NEST_TAG_HEAD_TITLE = u'Tag archives'
	NEST_TAG_HEAD_DESCRIPTION = u'Tag archives'
	NEST_TAG_HEADER_TITLE = u'Tag'
	NEST_TAG_HEADER_SUBTITLE = u'Tag archives'
	# tags.html
	NEST_TAGS_HEAD_TITLE = u'Tags'
	NEST_TAGS_HEAD_DESCRIPTION = u'Tags List'
	NEST_TAGS_HEADER_TITLE = u'Tags'
	NEST_TAGS_HEADER_SUBTITLE = u'Tags List'
	NEST_TAGS_CONTENT_TITLE = u'Tags List'
	NEST_TAGS_CONTENT_LIST = u'tagged'
	# Static files
	STATIC_PATHS = ['images', 'extra/robots.txt', 'extra/favicon.ico', 'extra/logo.svg']
	EXTRA_PATH_METADATA = {
    	'extra/robots.txt': {'path': 'robots.txt'},
    	'extra/favicon.ico': {'path': 'favicon.ico'},
    	'extra/logo.svg': {'path': 'logo.svg'}
	}


## Third-party assets

The theme uses external softwares, scripts, libraries and artworks:

* [Bootstrap](http://getbootstrap.com/) 3.x.x
* [Open Sans Font](http://www.google.com/fonts/specimen/Open+Sans)