jekyll

Go to file

Alex Kessinger df1efeff25 Accept multiple config files from command line Parse config as if it can contain multiple references to config files. This allows you to pass in multiple config files from the command line Helps with issues #514 and #703		2013-04-10 10:19:48 -07:00
bin	Move port and host configuration options to Jekyll::DEFAULTS so Commander doesn't override in serving awkwardly.	2013-04-07 23:55:04 +02:00
features	Remove superfluous references to File#close	2013-04-08 17:08:17 -04:00
lib	Accept multiple config files from command line	2013-04-10 10:19:48 -07:00
script	Add a bootstrap script	2013-01-22 23:10:51 +00:00
site	Use paginate_path and don't help too much	2013-04-09 21:00:27 +02:00
test	Accept multiple config files from command line	2013-04-10 10:19:48 -07:00
.gitignore	ignore .ruby-version	2013-03-13 18:47:07 +00:00
.travis.yml	@mojombo and I are sick of Travis emails.	2013-03-19 22:38:58 +01:00
CONTRIBUTING.md	Clean up site docs to prepare for 1.0 release.	2013-04-03 19:06:05 +02:00
Gemfile	Explicitly require HTTPS rubygems source	2013-02-27 20:28:09 -05:00
History.txt	Update history to reflect merge of #413 .	2013-04-10 01:58:06 +02:00
LICENSE	convert to use rakegem	2010-04-21 13:55:01 -07:00
README.textile	Link to LICENSE	2013-04-08 09:47:30 -04:00
Rakefile	Add features:html task to Rakefile, use cucumber profiles	2013-03-04 03:13:06 +01:00
cucumber.yml	Change default format to pretty and create travis profile	2013-03-04 03:12:31 +01:00
jekyll.gemspec	Release 1.0.0.beta4	2013-04-09 21:31:23 +02:00

README.textile

h1. Jekyll

!https://travis-ci.org/mojombo/jekyll.png?branch=master!:https://travis-ci.org/mojombo/jekyll
"!https://codeclimate.com/github/mojombo/jekyll.png!":https://codeclimate.com/github/mojombo/jekyll

By Tom Preston-Werner, Nick Quaranto, and many awesome contributors!

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":http://pages.github.com, which you can use to host your project's page or blog right here from GitHub.

h2. Getting Started

* "Install":http://wiki.github.com/mojombo/jekyll/install the gem
* Read up about its "Usage":http://wiki.github.com/mojombo/jekyll/usage and "Configuration":http://wiki.github.com/mojombo/jekyll/configuration
* Take a gander at some existing "Sites":http://wiki.github.com/mojombo/jekyll/sites
* Fork and "Contribute":http://wiki.github.com/mojombo/jekyll/contribute your own modifications
* Have questions? Post them on the "Mailing List":http://groups.google.com/group/jekyll-rb

h2. Diving In

* "Migrate":http://wiki.github.com/mojombo/jekyll/blog-migrations from your previous system
* Learn how the "YAML Front Matter":http://wiki.github.com/mojombo/jekyll/yaml-front-matter works
* Put information on your site with "Template Data":http://wiki.github.com/mojombo/jekyll/template-data
* Customize the "Permalinks":http://wiki.github.com/mojombo/jekyll/permalinks your posts are generated with
* Use the built-in "Liquid Extensions":http://wiki.github.com/mojombo/jekyll/liquid-extensions to make your life easier
* Use custom "Plugins":http://wiki.github.com/mojombo/jekyll/Plugins to generate content specific to your site

h2. Runtime Dependencies

* Classifier: Generating related posts (Ruby)
* Directory Watcher: Auto-regeneration of sites (Ruby)
* Kramdown: Markdown-superset converter (Ruby)
* Liquid: Templating system (Ruby)
* Maruku: Default markdown engine (Ruby)

h2. Developer Dependencies

* RDiscount: Discount Markdown Processor (Ruby)
* RedCloth: Textile support (Ruby)
* RedGreen: Nicer test output (Ruby)
* RR: Mocking (Ruby)
* Shoulda: Test framework (Ruby)

h2. License

See "LICENSE":https://github.com/mojombo/jekyll/blob/master/LICENSE.