|Summary help replacing me|
|Jekyll is a simple static site generator written in Ruby and developed by GitHub co-founder Tom Preston-Werner. This page provides a verbose tutorial to install and configure Jekyll for both inexperienced and advanced users.|
|Related article title|
"Jekyll is a simple, blog aware, static site generator. It takes a template directory (representing the raw form of a website), runs it through Textile or Markdown and Liquid converters, and spits out a complete, static website suitable for serving with Apache or your favorite web server. This is also the engine behind GitHub Pages, which you can use to host your project’s page or blog right here from GitHub." 
Werner announced the release of Jekyll on his website on November 17, 2008.
- 1 Installation
- 2 Select a Markup Language
- 3 Configuration
- 4 Usage
- 5 Test
- 6 External Links
$ pacman -S ruby ruby-docs
Jekyll can then be installed for all users on the machine using the gem command as root. Alternative installation methods are available on the Ruby page.
Before installing Jekyll make sure to update RubyGems.
$ gem update --system
Then install Jekyll using the gem command.
$ gem install jekyll
Arch User Repository (Alternate)
Select a Markup Language
There are numerous different markup languages that are used to define text-to-HTML conversion tools.
Textile is the default markup language used by Jekyll.
Markdown is a markup language and text-to-HTML conversion tool developed in Perl by John Gruber. A perl and a pyhton implementation of Markdown can be found in [community], while numerous other implementations are available in the AUR.
Additionally, it has been implemented in C as Discount by David Parsons and a Ruby extension was written by Ryan Tomayko as RDiscount. You can install RDiscount with Rubygems as root or through the AUR.
$ gem install rdiscount -s http://gemcutter.org
Then add the following line to your Template:Filename.
A default Jekyll directory tree looks like the following, where "." denotes the root directory of your Jeykll generated website.
. |-- _config.yml |-- _layouts | |-- default.html | `-- post.html |-- _posts | |-- 2010-02-13-early-userspace-in-arch-linux.textile | `-- 2011-05-29-arch-linux-usb-install-and-rescue-media.textile |-- _site `-- index.html
The default file structure is available from Jekyll-Base on GitHub.
The Template:Filename file stores configuration data. It includes numerous configuration settings, which may also be called as flags. Full explanation and a default configuration can be found on GitHub.
Once you have configured your Template:Filename to your liking you need to create the files that will be processed by Jekyll to generate the website.
Next you need to create templates that Jekyll can process. These templates make use of the Liquid templating system to input data. For a full explanation check GitHub.
Create Index Layout
Create General Website Layout
Create Post Layout
Creating a Post
The content of each blog post will be contained within a file inside of the _posts directorys. To use the default naming convention each file should be saved with the year, month, date, post title and end with the *.md or *.textile depending on the markup language used (e.g. Template:Filename). The date defined in the filename will be used as the published date in the post. Additionally, the filename will be used to generate the permalink (i.e. /categories/year/month/day/title.html). To use an alternate permalink style or create your own review the explanation on GitHub.
To generate a static HTML website based on your Textile or Markdown documents run jekyll. To simultaneously test the generated HTML website run Jekyll with the --server flag.
$ jekyll --server
It is recommended to define server options in your Template:Filename. The default will start a server on port 4000, which can be accessed in your web browser at localhost:4000.
Websites created with Jeykll by Arch Linux users. Further examples can be found on GitHub.