jekyll-docs 3.0.3 → 3.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/site/_config.yml +4 -0
- data/site/_data/docs.yml +3 -1
- data/site/_docs/assets.md +4 -3
- data/site/_docs/conduct.md +55 -0
- data/site/_docs/configuration.md +77 -7
- data/site/_docs/contributing.md +1 -1
- data/site/_docs/datafiles.md +3 -3
- data/site/_docs/deployment-methods.md +49 -28
- data/site/_docs/extras.md +1 -1
- data/site/_docs/github-pages.md +27 -28
- data/site/_docs/history.md +356 -196
- data/site/_docs/index.md +1 -0
- data/site/_docs/installation.md +4 -4
- data/site/_docs/pages.md +20 -4
- data/site/_docs/pagination.md +7 -4
- data/site/_docs/permalinks.md +4 -3
- data/site/_docs/plugins.md +20 -8
- data/site/_docs/posts.md +8 -8
- data/site/_docs/quickstart.md +1 -2
- data/site/_docs/resources.md +16 -24
- data/site/_docs/sites.md +1 -7
- data/site/_docs/structure.md +3 -3
- data/site/_docs/templates.md +39 -13
- data/site/_docs/upgrading.md +3 -133
- data/site/_docs/upgrading/0-to-2.md +140 -0
- data/site/_docs/upgrading/2-to-3.md +126 -0
- data/site/_docs/variables.md +1 -1
- data/site/_docs/windows.md +5 -3
- data/site/_includes/docs_ul.html +2 -6
- data/site/_includes/footer.html +1 -1
- data/site/_posts/2015-10-26-jekyll-3-0-released.markdown +1 -1
- data/site/_posts/2016-01-20-jekyll-3-0-2-released.markdown +5 -0
- data/site/_posts/2016-01-24-jekyll-3-1-0-released.markdown +50 -0
- data/site/_posts/2016-01-28-jekyll-3-1-1-released.markdown +33 -0
- data/site/_posts/2016-02-08-jekyll-3-0-3-released.markdown +4 -3
- data/site/_posts/2016-02-19-jekyll-3-1-2-released.markdown +20 -0
- data/site/_sass/_style.scss +4 -0
- data/site/help/index.md +5 -0
- data/site/index.html +2 -2
- data/site/latest_version.txt +1 -1
- data/site/redirects/github.html +4 -0
- data/site/redirects/issues.html +4 -0
- metadata +11 -3
data/site/_docs/index.md
CHANGED
data/site/_docs/installation.md
CHANGED
@@ -4,10 +4,10 @@ title: Installation
|
|
4
4
|
permalink: /docs/installation/
|
5
5
|
---
|
6
6
|
|
7
|
-
Getting Jekyll installed and ready-to-go should only take a few minutes.
|
8
|
-
ever becomes a pain
|
9
|
-
|
10
|
-
|
7
|
+
Getting Jekyll installed and ready-to-go should only take a few minutes.
|
8
|
+
If it ever becomes a pain, please [file an issue]({{ site.repository }}/issues/new)
|
9
|
+
(or submit a pull request) describing the issue you
|
10
|
+
encountered and how we might make the process easier
|
11
11
|
|
12
12
|
### Requirements
|
13
13
|
|
data/site/_docs/pages.md
CHANGED
@@ -27,12 +27,14 @@ homepage of your Jekyll-generated site.
|
|
27
27
|
|
28
28
|
## Where additional pages live
|
29
29
|
|
30
|
-
Where you put HTML
|
30
|
+
Where you put HTML or [Markdown](http://daringfireball.net/projects/markdown/)
|
31
|
+
files for pages depends on how you want the pages to work.
|
31
32
|
There are two main ways of creating pages:
|
32
33
|
|
33
|
-
- Place named HTML
|
34
|
+
- Place named HTML or [Markdown](http://daringfireball.net/projects/markdown/)
|
35
|
+
files for each page in your site's root folder.
|
34
36
|
- Create a folder in the site's root for each page, and place an index.html
|
35
|
-
file in each page folder.
|
37
|
+
or index.md file in each page folder.
|
36
38
|
|
37
39
|
Both methods work fine (and can be used in conjunction with each other),
|
38
40
|
with the only real difference being the resulting URLs.
|
@@ -53,6 +55,7 @@ and associated URLs might look like:
|
|
53
55
|
|-- _site/
|
54
56
|
|-- about.html # => http://example.com/about.html
|
55
57
|
|-- index.html # => http://example.com/
|
58
|
+
|-- other.md # => http://example.com/other.html
|
56
59
|
└── contact.html # => http://example.com/contact.html
|
57
60
|
{% endhighlight %}
|
58
61
|
|
@@ -77,8 +80,21 @@ might look like:
|
|
77
80
|
| └── index.html # => http://example.com/about/
|
78
81
|
├── contact/
|
79
82
|
| └── index.html # => http://example.com/contact/
|
83
|
+
|── other/
|
84
|
+
| └── index.md # => http://example.com/other/
|
80
85
|
└── index.html # => http://example.com/
|
81
86
|
{% endhighlight %}
|
82
87
|
|
83
88
|
This approach may not suit everyone, but for people who like clean URLs it’s
|
84
|
-
simple and it works. In the end the decision is yours!
|
89
|
+
simple and it works. In the end, the decision is yours!
|
90
|
+
|
91
|
+
<div class="note">
|
92
|
+
<h5>ProTip™: Use permalink Front Matter Variable</h5>
|
93
|
+
<p>
|
94
|
+
Clean URLs can also be achieved using the <code>permalink</code> front
|
95
|
+
matter variable. In the example above, using the first method, you can
|
96
|
+
get URL <code>http://example.com/other</code> for the file
|
97
|
+
<code>other.md</code> by setting this at the top of the file:
|
98
|
+
<code>permalink: /other</code>
|
99
|
+
</p>
|
100
|
+
</div>
|
data/site/_docs/pagination.md
CHANGED
@@ -4,10 +4,13 @@ title: Pagination
|
|
4
4
|
permalink: /docs/pagination/
|
5
5
|
---
|
6
6
|
|
7
|
-
With many websites
|
8
|
-
of posts up into smaller lists and display them over
|
9
|
-
pagination
|
10
|
-
and folders you need for paginated listings.
|
7
|
+
With many websites — especially blogs — it’s very common to
|
8
|
+
break the main listing of posts up into smaller lists and display them over
|
9
|
+
multiple pages. Jekyll offers a pagination plugin, so you can automatically
|
10
|
+
generate the appropriate files and folders you need for paginated listings.
|
11
|
+
|
12
|
+
For Jekyll 3, include the `jekyll-paginate` plugin in your Gemfile and in
|
13
|
+
your `_config.yml` under `gems`. For Jekyll 2, this is standard.
|
11
14
|
|
12
15
|
<div class="note info">
|
13
16
|
<h5>Pagination only works within HTML files</h5>
|
data/site/_docs/permalinks.md
CHANGED
@@ -79,7 +79,7 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
|
|
79
79
|
</td>
|
80
80
|
<td>
|
81
81
|
<p>
|
82
|
-
Hour of the day, 24-hour clock, zero-padded from the
|
82
|
+
Hour of the day, 24-hour clock, zero-padded from the post’s <code>date</code> front matter. (00..23)
|
83
83
|
</p>
|
84
84
|
</td>
|
85
85
|
</tr>
|
@@ -89,7 +89,7 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
|
|
89
89
|
</td>
|
90
90
|
<td>
|
91
91
|
<p>
|
92
|
-
Minute of the hour from the
|
92
|
+
Minute of the hour from the post’s <code>date</code> front matter. (00..59)
|
93
93
|
</p>
|
94
94
|
</td>
|
95
95
|
</tr>
|
@@ -99,7 +99,8 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
|
|
99
99
|
</td>
|
100
100
|
<td>
|
101
101
|
<p>
|
102
|
-
Second of the minute from the
|
102
|
+
Second of the minute from the post’s <code>date</code> front matter. (00..59)
|
103
|
+
</p>
|
103
104
|
</p>
|
104
105
|
</td>
|
105
106
|
</tr>
|
data/site/_docs/plugins.md
CHANGED
@@ -32,10 +32,10 @@ Jekyll generates your site.
|
|
32
32
|
values of the gem names of the plugins you'd like to use. An example:
|
33
33
|
|
34
34
|
|
35
|
-
gems: [jekyll-
|
35
|
+
gems: [jekyll-coffeescript, jekyll-watch, jekyll-assets]
|
36
36
|
# This will require each of these gems automatically.
|
37
37
|
|
38
|
-
Then install your plugins using `gem install jekyll-
|
38
|
+
Then install your plugins using `gem install jekyll-coffeescript jekyll-watch jekyll-assets`
|
39
39
|
|
40
40
|
3. Add the relevant plugins to a Bundler group in your `Gemfile`. An
|
41
41
|
example:
|
@@ -60,12 +60,13 @@ values of the gem names of the plugins you'd like to use. An example:
|
|
60
60
|
</p>
|
61
61
|
</div>
|
62
62
|
|
63
|
-
In general, plugins you make will fall into one of
|
63
|
+
In general, plugins you make will fall into one of five categories:
|
64
64
|
|
65
65
|
1. [Generators](#generators)
|
66
66
|
2. [Converters](#converters)
|
67
67
|
3. [Commands](#commands)
|
68
68
|
4. [Tags](#tags)
|
69
|
+
5. [Hooks](#hooks)
|
69
70
|
|
70
71
|
## Generators
|
71
72
|
|
@@ -736,6 +737,8 @@ LESS.js files during generation.
|
|
736
737
|
- [Jekyll Portfolio Generator by Shannon Babincsak](https://github.com/codeinpink/jekyll-portfolio-generator): Generates project pages and computes related projects out of project data files.
|
737
738
|
- [Jekyll-Umlauts by Arne Gockeln](https://github.com/webchef/jekyll-umlauts): This generator replaces all german umlauts (äöüß) case sensitive with html.
|
738
739
|
- [Jekyll Flickr Plugin](https://github.com/lawmurray/indii-jekyll-flickr) by [Lawrence Murray](http://www.indii.org): Generates posts for photos uploaded to a Flickr photostream.
|
740
|
+
- [Jekyll::Paginate::Category](https://github.com/midnightSuyama/jekyll-paginate-category): Pagination Generator for Jekyll Category.
|
741
|
+
- [AMP-Jekyll by Juuso Mikkonen](https://github.com/juusaw/amp-jekyll): Generate [Accelerated Mobile Pages](https://www.ampproject.org) of Jekyll posts.
|
739
742
|
|
740
743
|
#### Converters
|
741
744
|
|
@@ -760,6 +763,7 @@ LESS.js files during generation.
|
|
760
763
|
- [Bigfootnotes Plugin](https://github.com/TheFox/jekyll-bigfootnotes): Enables big footnotes for Kramdown.
|
761
764
|
- [AsciiDoc Plugin](https://github.com/asciidoctor/jekyll-asciidoc): AsciiDoc convertor for Jekyll using [Asciidoctor](http://asciidoctor.org/).
|
762
765
|
- [Lazy Tweet Embedding](https://github.com/takuti/jekyll-lazy-tweet-embedding): Automatically convert tweet urls into twitter cards.
|
766
|
+
- [jekyll-commonmark](https://github.com/pathawks/jekyll-commonmark): Markdown converter that uses [libcmark](https://github.com/jgm/CommonMark), the reference parser for CommonMark.
|
763
767
|
|
764
768
|
#### Filters
|
765
769
|
|
@@ -773,6 +777,7 @@ LESS.js files during generation.
|
|
773
777
|
- [pluralize](https://github.com/bdesham/pluralize): Easily combine a number and a word into a grammatically-correct amount like “1 minute” or “2 minute**s**”.
|
774
778
|
- [reading_time](https://github.com/bdesham/reading_time): Count words and estimate reading time for a piece of text, ignoring HTML elements that are unlikely to contain running text.
|
775
779
|
- [Table of Content Generator](https://github.com/dafi/jekyll-toc-generator): Generate the HTML code containing a table of content (TOC), the TOC can be customized in many way, for example you can decide which pages can be without TOC.
|
780
|
+
- [jekyll-toc](https://github.com/toshimaru/jekyll-toc): A liquid filter plugin for Jekyll which generates a table of contents.
|
776
781
|
- [jekyll-humanize](https://github.com/23maverick23/jekyll-humanize): This is a port of the Django app humanize which adds a "human touch" to data. Each method represents a Fluid type filter that can be used in your Jekyll site templates. Given that Jekyll produces static sites, some of the original methods do not make logical sense to port (e.g. naturaltime).
|
777
782
|
- [Jekyll-Ordinal](https://github.com/PatrickC8t/Jekyll-Ordinal): Jekyll liquid filter to output a date ordinal such as "st", "nd", "rd", or "th".
|
778
783
|
- [Deprecated articles keeper](https://github.com/kzykbys/JekyllPlugins) by [Kazuya Kobayashi](http://blog.kazuya.co/): A simple Jekyll filter which monitor how old an article is.
|
@@ -780,6 +785,9 @@ LESS.js files during generation.
|
|
780
785
|
- [Jekyll Thumbnail Filter](https://github.com/matallo/jekyll-thumbnail-filter): Related posts thumbnail filter.
|
781
786
|
- [Jekyll-Smartify](https://github.com/pathawks/jekyll-smartify): SmartyPants filter. Make "quotes" “curly”
|
782
787
|
- [liquid-md5](https://github.com/pathawks/liquid-md5): Returns an MD5 hash. Helpful for generating Gravatars in templates.
|
788
|
+
- [jekyll-roman](https://github.com/paulrobertlloyd/jekyll-roman): A liquid filter for Jekyll that converts numbers into Roman numerals.
|
789
|
+
- [jekyll-typogrify](https://github.com/myles/jekyll-typogrify): A Jekyll plugin that brings the functions of [typogruby](http://avdgaag.github.io/typogruby/).
|
790
|
+
- [Jekyll Email Protect](https://github.com/vwochnik/jekyll-email-protect): Email protection liquid filter for Jekyll
|
783
791
|
|
784
792
|
#### Tags
|
785
793
|
|
@@ -813,6 +821,7 @@ LESS.js files during generation.
|
|
813
821
|
- [Jekyll-swfobject](https://github.com/sectore/jekyll-swfobject): Liquid plugin for embedding Adobe Flash files (.swf) using [SWFObject](http://code.google.com/p/swfobject/).
|
814
822
|
- [Jekyll Picture Tag](https://github.com/robwierzbowski/jekyll-picture-tag): Easy responsive images for Jekyll. Based on the proposed [`<picture>`](https://html.spec.whatwg.org/multipage/embedded-content.html#the-picture-element) element, polyfilled with Scott Jehl’s [Picturefill](https://github.com/scottjehl/picturefill).
|
815
823
|
- [Jekyll Image Tag](https://github.com/robwierzbowski/jekyll-image-tag): Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.
|
824
|
+
- [Jekyll Responsive Image](https://github.com/wildlyinaccurate/jekyll-responsive-image): Responsive images for Jekyll. Automatically resizes images, supports all responsive methods (`<picture>`, `srcset`, Imager.js, etc), super-flexible configuration.
|
816
825
|
- [Ditaa Tag](https://github.com/matze/jekyll-ditaa) by [matze](https://github.com/matze): Renders ASCII diagram art into PNG images and inserts a figure tag.
|
817
826
|
- [Jekyll Suggested Tweet](https://github.com/davidensinger/jekyll-suggested-tweet) by [David Ensinger](https://github.com/davidensinger/): A Liquid tag for Jekyll that allows for the embedding of suggested tweets via Twitter’s Web Intents API.
|
818
827
|
- [Jekyll Date Chart](https://github.com/GSI/jekyll_date_chart) by [GSI](https://github.com/GSI): Block that renders date line charts based on textile-formatted tables.
|
@@ -822,7 +831,7 @@ LESS.js files during generation.
|
|
822
831
|
- [Lychee Gallery Tag](https://gist.github.com/tobru/9171700) by [tobru](https://github.com/tobru): Include [Lychee](http://lychee.electerious.com/) albums into a post. For an introduction, see [Jekyll meets Lychee - A Liquid Tag plugin](https://tobrunet.ch/articles/jekyll-meets-lychee-a-liquid-tag-plugin/)
|
823
832
|
- [Image Set/Gallery Tag](https://github.com/callmeed/jekyll-image-set) by [callmeed](https://github.com/callmeed): Renders HTML for an image gallery from a folder in your Jekyll site. Just pass it a folder name and class/tag options.
|
824
833
|
- [jekyll_figure](https://github.com/lmullen/jekyll_figure): Generate figures and captions with links to the figure in a variety of formats
|
825
|
-
- [Jekyll
|
834
|
+
- [Jekyll GitHub Sample Tag](https://github.com/bwillis/jekyll-github-sample): A liquid tag to include a sample of a github repo file in your Jekyll site.
|
826
835
|
- [Jekyll Project Version Tag](https://github.com/rob-murray/jekyll-version-plugin): A Liquid tag plugin that renders a version identifier for your Jekyll site sourced from the git repository containing your code.
|
827
836
|
- [Piwigo Gallery](https://github.com/AlessandroLorenzi/piwigo_gallery) by [Alessandro Lorenzi](http://www.alorenzi.eu/): Jekyll plugin to generate thumbnails from a Piwigo gallery and display them with a Liquid tag
|
828
837
|
- [mathml.rb](https://github.com/tmthrgd/jekyll-plugins) by Tom Thorogood: A plugin to convert TeX mathematics into MathML for display.
|
@@ -831,12 +840,11 @@ LESS.js files during generation.
|
|
831
840
|
- [inline\_highlight](https://github.com/bdesham/inline_highlight): A tag for inline syntax highlighting.
|
832
841
|
- [jekyll-mermaid](https://github.com/jasonbellamy/jekyll-mermaid): Simplify the creation of mermaid diagrams and flowcharts in your posts and pages.
|
833
842
|
- [twa](https://github.com/Ezmyrelda/twa): Twemoji Awesome plugin for Jekyll. Liquid tag allowing you to use twitter emoji in your jekyll pages.
|
834
|
-
- [jekyll-files](https://github.com/x43x61x69/jekyll-files) by [Zhi-Wei Cai](http://vox.vg/): Output relative path strings and other info regarding specific assets.
|
835
843
|
- [Fetch remote file content](https://github.com/dimitri-koenig/jekyll-plugins) by [Dimitri König](https://www.dimitrikoenig.net/): Using `remote_file_content` tag you can fetch the content of a remote file and include it as if you would put the content right into your markdown file yourself. Very useful for including code from github repo's to always have a current repo version.
|
836
844
|
- [jekyll-asciinema](https://github.com/mnuessler/jekyll-asciinema): A tag for embedding asciicasts recorded with [asciinema](https://asciinema.org) in your Jekyll pages.
|
837
845
|
- [Jekyll-Youtube](https://github.com/dommmel/jekyll-youtube) A Liquid tag that embeds Youtube videos. The default emded markup is responsive but you can also specify your own by using an include/partial.
|
838
846
|
- [Jekyll Flickr Plugin](https://github.com/lawmurray/indii-jekyll-flickr) by [Lawrence Murray](http://www.indii.org): Embeds Flickr photosets (albums) as a gallery of thumbnails, with lightbox links to larger images.
|
839
|
-
|
847
|
+
- [jekyll-figure](https://github.com/paulrobertlloyd/jekyll-figure): A liquid tag for Jekyll that generates `<figure>` elements.
|
840
848
|
|
841
849
|
#### Collections
|
842
850
|
|
@@ -852,6 +860,7 @@ LESS.js files during generation.
|
|
852
860
|
- [Growl Notification Generator by Tate Johnson](https://gist.github.com/490101): Send Jekyll notifications to Growl.
|
853
861
|
- [Growl Notification Hook by Tate Johnson](https://gist.github.com/525267): Better alternative to the above, but requires his “hook” fork.
|
854
862
|
- [Related Posts by Lawrence Woodman](https://github.com/LawrenceWoodman/related_posts-jekyll_plugin): Overrides `site.related_posts` to use categories to assess relationship.
|
863
|
+
- [jekyll-tagging-related_posts](https://github.com/toshimaru/jekyll-tagging-related_posts): Jekyll related_posts function based on tags (works on Jekyll3).
|
855
864
|
- [Tiered Archives by Eli Naeher](https://gist.github.com/88cda643aa7e3b0ca1e5): Create tiered template variable that allows you to group archives by year and month.
|
856
865
|
- [Jekyll-localization](https://github.com/blackwinter/jekyll-localization): Jekyll plugin that adds localization features to the rendering engine.
|
857
866
|
- [Jekyll-rendering](https://github.com/blackwinter/jekyll-rendering): Jekyll plugin to provide alternative rendering engines.
|
@@ -864,15 +873,17 @@ LESS.js files during generation.
|
|
864
873
|
- [File compressor](https://gist.github.com/2758691) by [mytharcher](https://github.com/mytharcher): Compress HTML and JavaScript files on site build.
|
865
874
|
- [Jekyll-minibundle](https://github.com/tkareine/jekyll-minibundle): Asset bundling and cache busting using external minification tool of your choice. No gem dependencies.
|
866
875
|
- [Singlepage-jekyll](https://github.com/JCB-K/singlepage-jekyll) by [JCB-K](https://github.com/JCB-K): Turns Jekyll into a dynamic one-page website.
|
867
|
-
- [generator-jekyllrb](https://github.com/robwierzbowski/generator-jekyllrb): A generator that wraps Jekyll in [Yeoman](http://yeoman.io/), a tool collection and workflow for
|
876
|
+
- [generator-jekyllrb](https://github.com/robwierzbowski/generator-jekyllrb): A generator that wraps Jekyll in [Yeoman](http://yeoman.io/), a tool collection and workflow for building modern web apps.
|
868
877
|
- [grunt-jekyll](https://github.com/dannygarcia/grunt-jekyll): A straightforward [Grunt](http://gruntjs.com/) plugin for Jekyll.
|
869
878
|
- [jekyll-postfiles](https://github.com/indirect/jekyll-postfiles): Add `_postfiles` directory and {% raw %}`{{ postfile }}`{% endraw %} tag so the files a post refers to will always be right there inside your repo.
|
870
|
-
- [A layout that compresses HTML](http://jch.penibelst.de/):
|
879
|
+
- [A layout that compresses HTML](http://jch.penibelst.de/): GitHub Pages compatible, configurable way to compress HTML files on site build.
|
871
880
|
- [Jekyll CO₂](https://github.com/wdenton/jekyll-co2): Generates HTML showing the monthly change in atmospheric CO₂ at the Mauna Loa observatory in Hawaii.
|
872
881
|
- [remote-include](http://www.northfieldx.co.uk/remote-include/): Includes files using remote URLs
|
873
882
|
- [jekyll-minifier](https://github.com/digitalsparky/jekyll-minifier): Minifies HTML, XML, CSS, and Javascript both inline and as separate files utilising yui-compressor and htmlcompressor.
|
874
883
|
- [Jekyll views router](https://bitbucket.org/nyufac/jekyll-views-router): Simple router between generator plugins and templates.
|
875
884
|
- [Jekyll Language Plugin](https://github.com/vwochnik/jekyll-language-plugin): Jekyll 3.0-compatible multi-language plugin for posts, pages and includes.
|
885
|
+
- [Jekyll Deploy](https://github.com/vwochnik/jekyll-deploy): Adds a `deploy` sub-command to Jekyll.
|
886
|
+
- [Official Contentful Jekyll Plugin](https://github.com/contentful/jekyll-contentful-data-import): Adds a `contentful` sub-command to Jekyll to import data from Contentful.
|
876
887
|
|
877
888
|
#### Editors
|
878
889
|
|
@@ -880,6 +891,7 @@ LESS.js files during generation.
|
|
880
891
|
- [vim-jekyll](https://github.com/parkr/vim-jekyll): A vim plugin to generate
|
881
892
|
new posts and run `jekyll build` all without leaving vim.
|
882
893
|
- [markdown-writer](https://atom.io/packages/markdown-writer): An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.
|
894
|
+
- [Wordpress2Jekyll](https://wordpress.org/plugins/wp2jekyll/): A Wordpress plugin that allows you to use Wordpress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.
|
883
895
|
|
884
896
|
<div class="note info">
|
885
897
|
<h5>Jekyll Plugins Wanted</h5>
|
data/site/_docs/posts.md
CHANGED
@@ -6,10 +6,10 @@ permalink: /docs/posts/
|
|
6
6
|
|
7
7
|
One of Jekyll’s best aspects is that it is “blog aware”. What does this mean,
|
8
8
|
exactly? Well, simply put, it means that blogging is baked into Jekyll’s
|
9
|
-
functionality. If you write articles and publish them online,
|
10
|
-
|
11
|
-
|
12
|
-
|
9
|
+
functionality. If you write articles and publish them online, you can publish
|
10
|
+
and maintain a blog simply by managing a folder of text-files on your computer.
|
11
|
+
Compared to the hassle of configuring and maintaining databases and web-based
|
12
|
+
CMS systems, this will be a welcome change!
|
13
13
|
|
14
14
|
## The Posts Folder
|
15
15
|
|
@@ -23,7 +23,7 @@ static site.
|
|
23
23
|
|
24
24
|
### Creating Post Files
|
25
25
|
|
26
|
-
To create a new post, all you need to do is create a
|
26
|
+
To create a new post, all you need to do is create a file in the `_posts`
|
27
27
|
directory. How you name files in this folder is important. Jekyll requires blog
|
28
28
|
post files to be named according to the following format:
|
29
29
|
|
@@ -84,21 +84,21 @@ One common solution is to create a folder in the root of the project directory
|
|
84
84
|
called something like `assets` or `downloads`, into which any images, downloads
|
85
85
|
or other resources are placed. Then, from within any post, they can be linked
|
86
86
|
to using the site’s root as the path for the asset to include. Again, this will
|
87
|
-
depend on the way your site’s (sub)domain and path are configured, but here
|
87
|
+
depend on the way your site’s (sub)domain and path are configured, but here are
|
88
88
|
some examples (in Markdown) of how you could do this using the `site.url`
|
89
89
|
variable in a post.
|
90
90
|
|
91
91
|
Including an image asset in a post:
|
92
92
|
|
93
93
|
{% highlight text %}
|
94
|
-
|
94
|
+
... which is shown in the screenshot below:
|
95
95
|
![My helpful screenshot]({% raw %}{{ site.url }}{% endraw %}/assets/screenshot.jpg)
|
96
96
|
{% endhighlight %}
|
97
97
|
|
98
98
|
Linking to a PDF for readers to download:
|
99
99
|
|
100
100
|
{% highlight text %}
|
101
|
-
|
101
|
+
... you can [get the PDF]({% raw %}{{ site.url }}{% endraw %}/assets/mydoc.pdf) directly.
|
102
102
|
{% endhighlight %}
|
103
103
|
|
104
104
|
<div class="note">
|
data/site/_docs/quickstart.md
CHANGED
@@ -14,8 +14,7 @@ For the impatient, here's how to get a boilerplate Jekyll site up and running.
|
|
14
14
|
# => Now browse to http://localhost:4000
|
15
15
|
{% endhighlight %}
|
16
16
|
|
17
|
-
If you wish to install jekyll into
|
18
|
-
alternatively running `jekyll new .` instead of a new directory name.
|
17
|
+
If you wish to install jekyll into an existing directory, you can do so by running `jekyll new .` from within the directory instead of creating a new one. If the existing directory isn't empty, you'll also have to pass the `--force` option like so `jekyll new . --force`.
|
19
18
|
|
20
19
|
That's nothing, though. The real magic happens when you start creating blog
|
21
20
|
posts, using the front matter to control templates and layouts, and taking
|
data/site/_docs/resources.md
CHANGED
@@ -6,41 +6,33 @@ permalink: /docs/resources/
|
|
6
6
|
|
7
7
|
Jekyll’s growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.
|
8
8
|
|
9
|
-
###
|
10
|
-
|
11
|
-
- [Tips for working with GitHub Pages Integration](https://gist.github.com/2890453)
|
12
|
-
|
13
|
-
Code example reuse, and keeping documentation up to date.
|
14
|
-
|
15
|
-
- [Use FormKeep for Jekyll form backend and webhooks](https://formkeep.com/)
|
16
|
-
- [Use Simple Form to integrate a simple contact
|
17
|
-
form](http://getsimpleform.com/)
|
18
|
-
- [JekyllBootstrap.com](http://jekyllbootstrap.com)
|
19
|
-
|
20
|
-
Provides detailed explanations, examples, and helper-code to make
|
21
|
-
getting started with Jekyll easier.
|
22
|
-
|
23
|
-
### Tutorials
|
24
|
-
|
25
|
-
#### Integrating Jekyll with Git
|
9
|
+
### Useful Guides
|
26
10
|
|
11
|
+
- [“Creating and Hosting a Personal Site on GitHub”](http://jmcglone.com/guides/github-pages/)
|
12
|
+
- [‘Build A Blog With Jekyll And GitHub Pages’ on Smashing Magazine](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/)
|
13
|
+
- Publishing to GitHub Pages? [Check out our documentation page for just that purpose](/docs/github-pages/).
|
27
14
|
- [Blogging with Git, Emacs and Jekyll](http://metajack.im/2009/01/23/blogging-with-git-emacs-and-jekyll/)
|
15
|
+
- [Tips for working with GitHub Pages Integration](https://gist.github.com/jedschneider/2890453)
|
28
16
|
|
29
|
-
|
17
|
+
### Integrations
|
30
18
|
|
19
|
+
- [Use FormKeep as a backend for forms (contact forms, hiring forms, etc.)](https://formkeep.com/guides/how-to-make-a-contact-form-in-jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=contact-form-jekyll)
|
20
|
+
- [Use Simple Form to add a simple contact form](http://getsimpleform.com/)
|
21
|
+
- [Jekyll Bootstrap](http://jekyllbootstrap.com), 0 to Blog in 3 minutes. Provides detailed explanations, examples, and helper-code to make getting started with Jekyll easier.
|
31
22
|
- [Integrating Twitter with Jekyll](http://www.justkez.com/integrating-twitter-with-jekyll/)
|
32
23
|
> “Having migrated Justkez.com to be based on Jekyll, I was pondering how I might include my recent twitterings on the front page of the site. In the WordPress world, this would have been done via a plugin which may or may not have hung the loading of the page, might have employed caching, but would certainly have had some overheads. … Not in Jekyll.”
|
24
|
+
|
25
|
+
### Other commentary
|
26
|
+
|
33
27
|
- [‘My Jekyll Fork’, by Mike West](http://mikewest.org/2009/11/my-jekyll-fork)
|
28
|
+
|
34
29
|
> “Jekyll is a well-architected throwback to a time before WordPress, when men were men, and HTML was static. I like the ideas it espouses, and have made a few improvements to it’s core. Here, I’ll point out some highlights of my fork in the hopes that they see usage beyond this site.”
|
30
|
+
|
35
31
|
- [‘About this Website’, by Carter Allen](http://cartera.me/2010/08/12/about-this-website/)
|
32
|
+
|
36
33
|
> “Jekyll is everything that I ever wanted in a blogging engine. Really. It isn’t perfect, but what’s excellent about it is that if there’s something wrong, I know exactly how it works and how to fix it. It runs on the your machine only, and is essentially an added”build" step between you and the browser. I coded this entire site in TextMate using standard HTML5 and CSS3, and then at the end I added just a few little variables to the markup. Presto-chango, my site is built and I am at peace with the world.”
|
37
|
-
- [‘Build A Blog With Jekyll And GitHub Pages’, by Barry Clark](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/)
|
38
|
-
> “I recently migrated my blog from WordPress to Jekyll, a fantastic website generator that’s designed for building minimal, static blogs to be hosted on GitHub Pages. The simplicity of Jekyll’s theming layer and writing workflow is fantastic; however, setting up my website took a lot longer than expected. In this article we'll walk through: the quickest way to set up a Jekyll powered blog, how to avoid common problems with using Jekyll, how to import your content from Wordpress, and more.”
|
39
|
-
- [Generating a Tag Cloud in Jekyll](http://www.justkez.com/generating-a-tag-cloud-in-jekyll/)
|
40
|
-
A guide to implementing a tag cloud and per-tag content pages using Jekyll.
|
41
34
|
|
35
|
+
- [Generating a Tag Cloud in Jekyll](http://www.justkez.com/generating-a-tag-cloud-in-jekyll/) – A guide to implementing a tag cloud and per-tag content pages using Jekyll.
|
42
36
|
- A way to [extend Jekyll](https://github.com/rfelix/jekyll_ext) without forking and modifying the Jekyll gem codebase and some [portable Jekyll extensions](https://wiki.github.com/rfelix/jekyll_ext/extensions) that can be reused and shared.
|
43
|
-
|
44
37
|
- [Using your Rails layouts in Jekyll](http://numbers.brighterplanet.com/2010/08/09/sharing-rails-views-with-jekyll)
|
45
|
-
|
46
38
|
- [Adding Ajax pagination to Jekyll](https://eduardoboucas.com/blog/2014/11/10/adding-ajax-pagination-to-jekyll.html)
|
data/site/_docs/sites.md
CHANGED
@@ -10,16 +10,10 @@ learning purposes.
|
|
10
10
|
|
11
11
|
- [Tom Preston-Werner](http://tom.preston-werner.com/)
|
12
12
|
([source](https://github.com/mojombo/mojombo.github.io))
|
13
|
-
- [Nick Quaranto](http://quaran.to/)
|
14
|
-
([source](https://github.com/qrush/qrush.github.com))
|
15
|
-
- [Roger Chapman](http://rogchap.com/)
|
16
|
-
([source](https://github.com/rogchap/rogchap.github.com))
|
17
13
|
- [GitHub Official Teaching Materials](http://training.github.com)
|
18
|
-
([source](https://github.com/github/training
|
14
|
+
([source](https://github.com/github/training-kit))
|
19
15
|
- [Rasmus Andersson](http://rsms.me/)
|
20
16
|
([source](https://github.com/rsms/rsms.github.com))
|
21
|
-
- [Scott Chacon](http://schacon.github.com)
|
22
|
-
([source](https://github.com/schacon/schacon.github.com))
|
23
17
|
- [Leonard Lamprecht](http://leo.im)
|
24
18
|
([source](https://github.com/leo/leo.github.io))
|
25
19
|
|
data/site/_docs/structure.md
CHANGED
@@ -7,9 +7,9 @@ permalink: /docs/structure/
|
|
7
7
|
Jekyll is, at its core, a text transformation engine. The concept behind the
|
8
8
|
system is this: you give it text written in your favorite markup language, be
|
9
9
|
that Markdown, Textile, or just plain HTML, and it churns that through a layout
|
10
|
-
or series of layout files. Throughout that process you can tweak how you want
|
10
|
+
or a series of layout files. Throughout that process you can tweak how you want
|
11
11
|
the site URLs to look, what data gets displayed in the layout, and more. This
|
12
|
-
is all done through editing text files
|
12
|
+
is all done through editing text files; the static web site is the final
|
13
13
|
product.
|
14
14
|
|
15
15
|
A basic Jekyll site usually looks something like this:
|
@@ -132,7 +132,7 @@ An overview of what each of these does:
|
|
132
132
|
<td>
|
133
133
|
<p>
|
134
134
|
|
135
|
-
Well-formatted site data should be placed here. The
|
135
|
+
Well-formatted site data should be placed here. The Jekyll engine
|
136
136
|
will autoload all YAML files in this directory (using either the
|
137
137
|
<code>.yml</code>, <code>.yaml</code>, <code>.json</code> or
|
138
138
|
<code>.csv</code> formats and extensions) and they will be
|
data/site/_docs/templates.md
CHANGED
@@ -186,6 +186,17 @@ common tasks easier.
|
|
186
186
|
</p>
|
187
187
|
</td>
|
188
188
|
</tr>
|
189
|
+
<tr>
|
190
|
+
<td>
|
191
|
+
<p class="name"><strong>Smartify</strong></p>
|
192
|
+
<p>Convert "quotes" into “smart quotes.”</p>
|
193
|
+
</td>
|
194
|
+
<td class="align-center">
|
195
|
+
<p>
|
196
|
+
<code class="filter">{% raw %}{{ page.title | smartify }}{% endraw %}</code>
|
197
|
+
</p>
|
198
|
+
</td>
|
199
|
+
</tr>
|
189
200
|
<tr>
|
190
201
|
<td>
|
191
202
|
<p class="name"><strong>Converting Sass/SCSS</strong></p>
|
@@ -246,6 +257,20 @@ common tasks easier.
|
|
246
257
|
</p>
|
247
258
|
</td>
|
248
259
|
</tr>
|
260
|
+
<tr>
|
261
|
+
<td>
|
262
|
+
<p class="name"><strong>Sample</strong></p>
|
263
|
+
<p>Pick a random value from an array. Optional: pick multiple values.</p>
|
264
|
+
</td>
|
265
|
+
<td class="align-center">
|
266
|
+
<p>
|
267
|
+
<code class="filter">{% raw %}{{ site.pages | sample }}{% endraw %}</code>
|
268
|
+
</p>
|
269
|
+
<p>
|
270
|
+
<code class="filter">{% raw %}{{ site.pages | sample:2 }}{% endraw %}</code>
|
271
|
+
</p>
|
272
|
+
</td>
|
273
|
+
</tr>
|
249
274
|
</tbody>
|
250
275
|
</table>
|
251
276
|
</div>
|
@@ -317,16 +342,16 @@ such as using variables.
|
|
317
342
|
|
318
343
|
### Code snippet highlighting
|
319
344
|
|
320
|
-
Jekyll has built in support for syntax highlighting of
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
file.
|
345
|
+
Jekyll has built in support for syntax highlighting of over 60 languages
|
346
|
+
thanks to [Rouge](http://rouge.jneen.net). Rouge is the default highlighter
|
347
|
+
in Jekyll 3 and above. To use it in Jekyll 2, set `highlighter` to `rouge`
|
348
|
+
and ensure the `rouge` gem is installed properly.
|
325
349
|
|
326
|
-
Alternatively, you can use [
|
327
|
-
your code snippets.
|
328
|
-
|
329
|
-
|
350
|
+
Alternatively, you can use [Pygments](http://pygments.org) to highlight
|
351
|
+
your code snippets. To use Pygments, you must have Python installed on your
|
352
|
+
system, have the `pygments.rb` gem installed and set `highlighter` to
|
353
|
+
`pygments` in your site's configuration file. Pygments supports [over 100
|
354
|
+
languages](http://pygments.org/languages/)
|
330
355
|
|
331
356
|
To render a code block with syntax highlighting, surround your code as follows:
|
332
357
|
|
@@ -342,9 +367,9 @@ end
|
|
342
367
|
|
343
368
|
The argument to the `highlight` tag (`ruby` in the example above) is the
|
344
369
|
language identifier. To find the appropriate identifier to use for the language
|
345
|
-
you want to highlight, look for the “short name” on the [
|
346
|
-
|
347
|
-
|
370
|
+
you want to highlight, look for the “short name” on the [Rouge
|
371
|
+
wiki](https://github.com/jayferd/rouge/wiki/List-of-supported-languages-and-lexers)
|
372
|
+
or the [Pygments' Lexers page](http://pygments.org/docs/lexers/).
|
348
373
|
|
349
374
|
#### Line numbers
|
350
375
|
|
@@ -422,4 +447,5 @@ You may also optionally specify the filename in the gist to display:
|
|
422
447
|
{% endraw %}
|
423
448
|
{% endhighlight %}
|
424
449
|
|
425
|
-
To use the `gist` tag, you'll need to add the
|
450
|
+
To use the `gist` tag, you'll need to add the
|
451
|
+
[jekyll-gist](https://github.com/jekyll/jekyll-gist) gem to your project.
|