Go to file

Matt Rogers 976cddf477 Update history to reflect merge of #1614		2013-10-10 20:49:55 -05:00
bin	Print better messages for detached server. Mute output on detach.	2013-09-12 14:02:52 -04:00
features	Add cucumber feature for layouts inside subfolders	2013-10-08 18:14:13 -03:00
lib	Merge pull request #1615 from benbalter/downcase-lexers	2013-10-10 18:48:00 -07:00
script	Add a bootstrap script	2013-01-22 23:10:51 +00:00
site	Merge pull request #1495 from maul-esel/variable-include	2013-10-04 05:42:27 -07:00
test	Merge pull request #1615 from benbalter/downcase-lexers	2013-10-10 18:48:00 -07:00
.gitignore	Remove duplicate	2013-08-21 23:08:26 +02:00
.travis.yml	Don't post to IRC unless it's really important.	2013-10-04 12:58:58 -04:00
CONTRIBUTING.markdown	Update CONTRIBUTING docs for better PRs.	2013-09-12 10:48:42 -04:00
Gemfile	simplify conditions for coverage reports	2013-09-14 15:28:41 +02:00
History.markdown	Update history to reflect merge of #1614	2013-10-10 20:49:55 -05:00
LICENSE	convert to use rakegem	2010-04-21 13:55:01 -07:00
README.markdown	add status badge to README	2013-09-12 21:19:36 +02:00
Rakefile	Merge pull request #1539 from maul-esel/coveralls	2013-09-16 18:28:28 -07:00
cucumber.yml	Change default format to pretty and create travis profile	2013-03-04 03:12:31 +01:00
jekyll.gemspec	Update safe_yaml dependency to ~> 0.9.7	2013-10-04 19:52:55 +02:00

README.markdown

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, which you can use to host your project's page or blog right here from GitHub.

Getting Started

Install the gem
Read up about its Usage and Configuration
Take a gander at some existing Sites
Fork and Contribute your own modifications
Have questions? Check out #jekyll on irc.freenode.net.

Diving In

Migrate from your previous system
Learn how the YAML Front Matter works
Put information on your site with Variables
Customize the Permalinks your posts are generated with
Use the built-in Liquid Extensions to make your life easier
Use custom Plugins to generate content specific to your site

Runtime Dependencies

Commander: Command-line interface constructor (Ruby)
Colorator: Colorizes command line output (Ruby)
Classifier: Generating related posts (Ruby)
Directory Watcher: Auto-regeneration of sites (Ruby)
Liquid: Templating system (Ruby)
Maruku: Default markdown engine (Ruby)
Pygments.rb: Syntax highlighting (Ruby/Python)
RedCarpet: Markdown engine (Ruby)
Safe YAML: YAML Parser built for security (Ruby)

Developer Dependencies

Kramdown: Markdown-superset converter (Ruby)
Launchy: Cross-platform file launcher (Ruby)
RDiscount: Discount Markdown Processor (Ruby)
RedCloth: Textile support (Ruby)
RedGreen: Nicer test output (Ruby)
RR: Mocking (Ruby)
Shoulda: Test framework (Ruby)
SimpleCov: Coverage framework (Ruby)

License

See LICENSE.