Go to file

Aidan Feldman 716b8ede0e Loosen dependency on Shoulda Fixes build for Ruby 2.1.0.		2014-01-03 05:44:47 -05:00
bin	make options consistent across commands	2013-12-26 02:00:26 -05:00
features	Merge pull request #1859 from robin850/rouge	2013-12-30 22:45:07 -06:00
lib	Merge pull request #1859 from robin850/rouge	2013-12-30 22:45:07 -06:00
script	Add a bootstrap script	2013-01-22 23:10:51 +00:00
site	Add a note about character sets	2014-01-02 14:53:03 -06:00
test	Update test_generated_site.rb to know about new post	2014-01-01 19:53:42 -08:00
.gitignore	Remove duplicate	2013-08-21 23:08:26 +02:00
.travis.yml	Test under Ruby 2.1.0	2014-01-02 14:39:00 -08:00
CONTRIBUTING.markdown	mojombo/jekyll ~> jekyll/jekyll	2013-12-11 17:44:33 -05:00
Gemfile	Add in test plugin for inclusion.	2013-10-04 15:49:47 -04:00
History.markdown	Update history to reflect merge of #1902	2014-01-02 13:26:08 -08:00
LICENSE	convert to use rakegem	2010-04-21 13:55:01 -07:00
README.markdown	mojombo/jekyll ~> jekyll/jekyll	2013-12-11 17:44:33 -05:00
Rakefile	Rakefile's site:releases:new should use 'release' variable instead of 'version' function to specify version in YAML front-matter	2013-12-16 20:31:21 -05:00
cucumber.yml	Change default format to pretty and create travis profile	2013-03-04 03:12:31 +01:00
jekyll.gemspec	Loosen dependency on Shoulda	2014-01-03 05:44:47 -05: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.