jekyll

Go to file

Matt Rogers 770402d912 Also stub the building of the index Since we don't actually use the index in getting the related posts from the tests there's no need to build an index, which can take a long time if the ruby bindings for the GSL library are not installed.		2013-05-08 22:33:20 -05:00
bin	Remove to_i. Let commander gem do it #1004	2013-04-29 15:56:02 +09:00
features	In Cucumber step definitions, it'd be smart not to chdir into a dir we're about to kill	2013-05-05 17:25:42 +02:00
lib	Update the display of the LSI progress output	2013-05-08 22:02:23 -05:00
script	Add a bootstrap script	2013-01-22 23:10:51 +00:00
site	Changed https to http in the GitHub Pages link. fixes #1051 .	2013-05-07 23:53:17 +02:00
test	Also stub the building of the index	2013-05-08 22:33:20 -05:00
.gitignore	ignore .ruby-version	2013-03-13 18:47:07 +00:00
.travis.yml	Compliant with Ruby 2.0.0	2013-04-26 21:20:48 +02:00
CONTRIBUTING.md	When one clones one's fork of Jekyll, one should not use the readonly git:// protocol. Instead, use SSH.	2013-04-26 19:09:11 +02:00
Gemfile	Explicitly require HTTPS rubygems source	2013-02-27 20:28:09 -05:00
History.markdown	Update History to reflect release of 1.0.1.	2013-05-08 01:06:11 +02:00
LICENSE	convert to use rakegem	2010-04-21 13:55:01 -07:00
README.textile	Update README links.	2013-05-06 10:01:51 +10:00
Rakefile	remove failsave for docs publishing	2013-05-06 01:16:14 +02: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.1	2013-05-08 01:03:14 +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://jekyllrb.com/docs/installation/ the gem
* Read up about its "Usage":http://jekyllrb.com/docs/usage/ and "Configuration":http://jekyllrb.com/docs/configuration/
* Take a gander at some existing "Sites":http://wiki.github.com/mojombo/jekyll/sites
* Fork and "Contribute":https://github.com/mojombo/jekyll/blob/master/CONTRIBUTING.md your own modifications
* Have questions? Post them on the "Mailing List":http://groups.google.com/group/jekyll-rb

h2. Diving In

* "Migrate":http://jekyllrb.com/docs/migrations/ from your previous system
* Learn how the "YAML Front Matter":http://jekyllrb.com/docs/frontmatter/ works
* Put information on your site with "Variables":http://jekyllrb.com/docs/variables/
* Customize the "Permalinks":http://jekyllrb.com/docs/permalinks/ your posts are generated with
* Use the built-in "Liquid Extensions":http://jekyllrb.com/docs/templates/ to make your life easier
* Use custom "Plugins":http://jekyllrb.com/docs/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.