jekyll 0.11.0 → 0.11.2

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of jekyll might be problematic. Click here for more details.

@@ -1,41 +0,0 @@
1
- == Preface
2
-
3
- Jekyll was born out the desire to create a blog engine that would make it
4
- possible to write posts in my local text editor, version those posts with Git,
5
- and keep up with my desire to tweak the styles and layout of my site.
6
-
7
- In other words, I wanted something that fit into my existing software
8
- development workflow and toolchain. Jekyll handles not only this case, but a
9
- wide variety of other situations that call for static site generation based on
10
- converted content and layout templates.
11
-
12
- At its core, Jekyll is a text transformation engine. The concept behind the
13
- system is this: you give it text written in your favorite markup language, be
14
- that Markdown, Textile, or just plain HTML, and it churns that through a
15
- layout or series of layout files. Throughout that process you can tweak how
16
- you want the site URLs to look, what data gets displayed on the layout and
17
- much more.
18
-
19
- If you're looking for a simple, yet powerful solution to your blogging or
20
- static site needs, Jekyll may be just what you've been looking for.
21
-
22
-
23
- === What this book covers
24
-
25
- _Chapter 1, Quick Start_ covers installation, introduces the Jekyll command
26
- line interface, and runs through a quick example demonstrating the site
27
- generator, post generator and how to convert your Jekyll site into a static
28
- site.
29
-
30
- _Chapter 2, Directory Layout_ covers the various files and directories that
31
- comprise a Jekyll site.
32
-
33
- _Chapter 3, Tags and Filters_
34
-
35
- _Chapter X, Deploying your Jekyll Site_
36
-
37
- _Chapter X, Customizing Jekyll with Plugins_
38
-
39
- _Chapter X, Migrating to Jekyll from your Existing Blog_
40
-
41
- _Chapter X, Configuration Reference_
@@ -1,153 +0,0 @@
1
- == Chapter 1: Quick Start
2
-
3
- This chapter is designed to get you up and running with Jekyll as quickly as
4
- possible.
5
-
6
-
7
- === Installation
8
-
9
- The best way to install Jekyll is via RubyGems:
10
-
11
- ----
12
- gem install jekyll
13
- ----
14
-
15
- This is all you need in order to get started with a basic Jekyll site. Some
16
- options require additional packages to be installed.
17
-
18
- If you encounter errors during gem installation, you may need to install the
19
- header files for compiling extension modules for ruby 1.8:
20
-
21
- .Debian
22
- ----
23
- sudo apt-get install ruby1.8-dev
24
- ----
25
-
26
- .Red Hat / CentOS / Fedora systems
27
- ----
28
- sudo yum install ruby-devel
29
- ----
30
-
31
- .NearlyFreeSpeech
32
- ----
33
- RB_USER_INSTALL=true gem install jekyll
34
- ----
35
-
36
- If you encounter errors like +Failed to build gem native extension+ on Windows
37
- you may need to install http://wiki.github.com/oneclick/rubyinstaller/development-kit[RubyInstaller
38
- DevKit].
39
-
40
- ==== LaTeX to PNG
41
-
42
- Maruku comes with optional support for LaTeX to PNG rendering via blahtex
43
- (Version 0.6) which must be in your $PATH along with @dvips@.
44
-
45
- (NOTE: "remi's fork of Maruku":http://github.com/remi/maruku/tree/master does
46
- not assume a fixed location for @dvips@ if you need that fixed)
47
-
48
- ==== RDiscount
49
-
50
- If you prefer to use
51
- http://github.com/rtomayko/rdiscount/tree/master[RDiscount] instead of
52
- http://maruku.rubyforge.org/[Maruku] for markdown, just make sure it's
53
- installed:
54
-
55
- ----
56
- sudo gem install rdiscount
57
- ----
58
-
59
- And run Jekyll with the following option:
60
-
61
- ----
62
- jekyll --rdiscount
63
- ----
64
-
65
- Or, in your @_config.yml@ file put the following so you don't have to specify the flag:
66
-
67
- ----
68
- markdown: rdiscount
69
- ----
70
-
71
- ==== Pygments
72
-
73
- If you want syntax highlighting via the @{% highlight %}@ tag in your posts,
74
- you'll need to install http://pygments.org/[Pygments].
75
-
76
- .On OSX with Homebrew
77
- ----
78
- brew install pip && pip install pygments
79
- ----
80
-
81
- .On OSX with MacPorts
82
- ----
83
- sudo port install python25 py25-pygments
84
- ----
85
-
86
- .Bare OS X Leopard
87
- ----
88
- sudo easy_install Pygments
89
- ----
90
-
91
- .Archlinux
92
- ----
93
- sudo pacman -S python-pygments
94
- ----
95
-
96
- .Archlinux python2 for Pygments
97
- ----
98
- $ sudo pacman -S python2-pygments
99
- ----
100
-
101
- NOTE: python2 pygments version creates a `pygmentize2` executable, while
102
- Jekyll tries to find `pygmentize`. Either create a symlink `# ln -s
103
- /usr/bin/pygmentize2 /usr/bin/pygmentize` or use the python3 version.
104
-
105
- .Ubuntu and Debian
106
- ----
107
- sudo apt-get install python-pygments
108
- ----
109
-
110
- .Gentoo
111
- ----
112
- $ sudo emerge -av dev-python/pygments
113
- ----
114
-
115
-
116
- === Creating your First Site
117
-
118
- Jekyll comes with a handy generator that will create a barebones skeleton site
119
- to help you get up and running in no time. Simply create an empty directory to
120
- contain your site, navigate to it, and run the generator command:
121
-
122
- ----
123
- $ mkdir mysite
124
- $ cd mysite
125
- $ jekyll gen
126
- ----
127
-
128
- Make sure the directory is empty or Jekyll will refuse to run. If everything
129
- was successful, you'll be left with a complete, valid Jekyll site that's ready
130
- to be converted into a static site.
131
-
132
- To perform the conversion, make sure you're in the root of your Jekyll site
133
- directory and run:
134
-
135
- ----
136
- $ jekyll --server
137
- ----
138
-
139
- If all goes well, you should get a few lines with information about config
140
- file detection, source and destination paths, and a success message.
141
-
142
- The `--server` command line option fires up a simple web server that will
143
- serve the static site we just generated so that we can easily preview what it
144
- will look like once we deploy it to a production environment.
145
-
146
- Open up your favorite web browser and navigate to:
147
-
148
- ----
149
- http://localhost:4000
150
- ----
151
-
152
- Congratulations! You have now successfully created and converted your first
153
- Jekyll site!
@@ -1,90 +0,0 @@
1
- == Chapter 2: Directory Layout
2
-
3
- If you followed the Quick Start in the last chapter, you have a Jekyll site on
4
- your local machine. Let's take a closer look at it and see what makes it tick.
5
- The file layout should look something like this:
6
-
7
- ----
8
- .
9
- |-- _config.yml
10
- |-- _layouts
11
- | |-- default.html
12
- | `-- post.html
13
- |-- _posts
14
- | |-- 2007-10-29-why-every-programmer-should-play-nethack.textile
15
- | `-- 2009-04-26-barcamp-boston-4-roundup.textile
16
- |-- _site
17
- |-- images
18
- | `-- logo.png
19
- `-- index.html
20
- ----
21
-
22
- Notice that some of the files and directories begin with an underscore. These
23
- have special meaning to Jekyll. The underscore ensures that they will not
24
- interfere with the rest of your site's normal content. It also means that if
25
- any of your normal files start with an underscore, they will cause problems,
26
- so try to avoid this.
27
-
28
- === _config.yml
29
-
30
- This file stores configuration data. A majority of these options can be
31
- specified from the command line executable but it's easier to throw them in
32
- here so you don't have to type them out every time. Detailed explanations of
33
- configuration directives can be found in Chapter X.
34
-
35
- === _layouts
36
-
37
- Files in this directory represent templates that can be used to wrap converted
38
- pages. Layouts are defined on a page-by-page basis in the YAML front matter.
39
- The liquid tag +{{ content }}+ specifies where the content will be placed
40
- during the conversion process.
41
-
42
- === _posts
43
-
44
- If you're using Jekyll as a blog engine, this is where you'll place your blog
45
- posts. A post's filename contains several pieces of data, so you must be very
46
- careful about how these files are named. The filename format is:
47
- +YEAR-MONTH-DATE-SLUG.MARKUP+. The YEAR must be four numbers and the MONTH and
48
- DATE must be two numbers each. The SLUG is what will appear in the URL. The
49
- MARKUP tells Jekyll the format of the post. The date and slug will be used
50
- along with any permalink options you specify (See Chapter X) to construct the
51
- final URL of the post.
52
-
53
- === _site
54
-
55
- This is where the generated site will be placed (by default) once Jekyll is
56
- done transforming it. If you're using version control, you'll want to add this
57
- directory to the list of files to be ignored.
58
-
59
- === Normal Files with YAML Front Matter
60
-
61
- All files outside of the special underscore directories and that do not
62
- themselves begin with an underscore will be scanned by Jekyll and subjected to
63
- conversion if they contain any YAML front matter.
64
-
65
- === Everything Else
66
-
67
- Any files and directories that do not fall into one of the above categories
68
- will be copied to the static site as-is without modification. In this example,
69
- +images/logo.png+ will be copied to the same location in the generated site.
70
-
71
-
72
-
73
-
74
- h2. Running Jekyll
75
-
76
- Usually this is done through the @jekyll@ executable, which is installed with
77
- the gem. In order to get a server up and running with your Jekyll site, run:
78
-
79
- @jekyll --server@
80
-
81
- and then browse to http://0.0.0.0:4000. There's plenty of [[configuration
82
- options|Configuration]] available to you as well.
83
-
84
- On Debian or Ubuntu, you may need to add @/var/lib/gems/1.8/bin/@ to your path.
85
-
86
- h2. Deployment
87
-
88
- Since Jekyll simply generates a folder filled with HTML files, it can be
89
- served using practically any available web server out there. Please check the
90
- [[Deployment]] page for more information regarding specific scenarios.
@@ -1,231 +0,0 @@
1
- /* BEG */
2
- /* ---------------------------------------------------------------------------
3
- Bare AsciiDoc styles
4
- Ryan Tomayko <r@tomayko.com>
5
- --------------------------------------------------------------------------- */
6
-
7
- body {
8
- font-family:verdana,helvetica,arial,sans-serif;
9
- font-size:81.25%; /* 13px */
10
- line-height:1.538; /* 20px */
11
- margin:40px 50px;
12
- max-width:53.8461538462em; /* 790px */
13
- color:#333;
14
- }
15
-
16
- em {
17
- font-style:italic;
18
- }
19
-
20
- strong {
21
- font-weight:bold;
22
- color:#000;
23
- }
24
-
25
- tt {
26
- font-family:consolas, 'lucida console', 'bitstream vera sans mono',
27
- 'courier new', monospace;
28
- color:#000;
29
- }
30
-
31
- p, ul, ol, dl {
32
- margin:10px 0
33
- }
34
-
35
- dl { }
36
-
37
- dt {
38
- font-weight:normal;
39
- color:#000;
40
- }
41
-
42
- h1, h2, h3, h4, h5 {
43
- font-family:'lucida grande',georgia,verdana,helvetica,arial,sans-serif;
44
- font-weight:normal;
45
- color:#000;
46
- }
47
-
48
- h1 {
49
- font-size:30px;
50
- line-height:1.428;
51
- margin:20px 0;
52
- }
53
-
54
- h2 {
55
- font-size:23px;
56
- line-height:1.36363636; /* repeating, of course */
57
- margin:20px 0;
58
- }
59
-
60
- h2 + .sectionbody {}
61
-
62
- h3 {
63
- font-size:18px;
64
- line-height:1.1;
65
- margin:30px 0 10px 0;
66
- }
67
-
68
- h4 {
69
- font-size:13px;
70
- font-weight:bold;
71
- line-height:1.538;
72
- }
73
-
74
- h5 {
75
- font-size:13px;
76
- font-style:italic;
77
- line-height:1.538;
78
- }
79
-
80
- pre {
81
- font-size:larger;
82
- }
83
-
84
- #header {
85
- text-align:center;
86
- margin-bottom:30px;
87
- }
88
-
89
- #header h1 { margin-bottom:0 }
90
-
91
-
92
- .title, .sidebar-title {
93
- font-weight:normal;
94
- margin-bottom:0;
95
- }
96
-
97
- .admonitionblock .title {
98
- font-weight:bold;
99
- }
100
-
101
- .admonitionblock {
102
- margin:30px 0px;
103
- color:#555;
104
- }
105
-
106
- .admonitionblock td.icon {
107
- width:30px;
108
- padding-right:20px;
109
- padding-left:20px;
110
- text-transform:uppercase;
111
- font-weight:bold;
112
- color:#888;
113
- }
114
-
115
- .listingblock .content {
116
- border:1px solid silver;
117
- background:#eee;
118
- padding:5px;
119
- }
120
-
121
- .listingblock .content pre {
122
- margin:0;
123
- }
124
-
125
- .literalblock .content {
126
- margin-left:40px;
127
- }
128
-
129
- .verseblock .content {
130
- white-space:pre
131
- }
132
-
133
- .sidebarblock .sidebar-content {
134
- border:1px solid silver;
135
- background:#FFFFEE;
136
- padding:0 10px;
137
- color:#222;
138
- font-size:smaller;
139
- line-height:1.5;
140
- }
141
-
142
- .sidebar-title {
143
- margin:10px 0;
144
- font-weight:bold;
145
- color:#442;
146
- }
147
-
148
- .quoteblock-content {
149
- font-style:italic;
150
- color:#444;
151
- margin-left:40px;
152
- }
153
-
154
- .quoteblock-content .attribution {
155
- font-style:normal;
156
- text-align:right;
157
- color:#000;
158
- }
159
-
160
- .exampleblock-content *:first-child { margin-top:0 }
161
- .exampleblock-content {
162
- border-left:2px solid silver;
163
- padding-left:8px;
164
- }
165
-
166
- #footer {
167
- font-size:11px;
168
- margin-top:40px;
169
- border-top:1px solid silver;
170
- color:#555;
171
- }
172
-
173
- #author {
174
- color:#000;
175
- text-transform:uppercase
176
- }
177
-
178
- /* vim: set ft=css ts=4 sw=4 noexpandtab: */
179
-
180
- /* END @import url(bare.css); */
181
-
182
- /* ---------------------------------------------------------------------------
183
- FreeBSD AsciiDoc Theme
184
- Ryan Tomayko <r@tomayko.com>
185
-
186
- Based on The FreeBSD Handbook and various other FreeBSD documenration.
187
- --------------------------------------------------------------------------- */
188
-
189
- body {
190
- font-family:verdana,helvetica,arial,sans-serif;
191
- font-size:100%;
192
- color:#000;
193
- }
194
-
195
- tt { color:#007A00 }
196
- pre tt { color:#000 }
197
-
198
- dt { color:#000 }
199
-
200
- h1, h2, h3, h4, h5 {
201
- font-family:'lucida grande',helvetica,verdana,sans-serif;
202
- color:#900;
203
- font-weight:bold;
204
- }
205
-
206
- #header {
207
- text-align:left;
208
- }
209
- #header h1 { margin-bottom:40px }
210
-
211
- h1 {
212
- font-size:36px;
213
- line-height:1;
214
- margin:40px 0;
215
- }
216
-
217
- h2 {
218
- font-size:28px;
219
- line-height:1;
220
- margin:30px 0 20px 0;
221
- }
222
-
223
- .sectionbody {
224
- margin-left:30px;
225
- }
226
-
227
- pre {
228
- background:#EEE;
229
- }
230
-
231
- /* vim: set ft=css ts=4 sw=4 noexpandtab: */