Go to file

Ben Balter e5f1a400ee first pass at vision		2014-01-12 11:57:11 -08:00
bin	Line -q up with the other flags. [ci skip]	2014-01-03 21:14:55 -08:00
features	Merge pull request #1859 from robin850/rouge	2013-12-30 22:45:07 -06:00
lib	Rename read_things to read_content.	2014-01-11 15:29:22 -06:00
script	Add script/cibuild.	2014-01-04 14:04:17 -08:00
site	Update the documentation for the new exclude behavior	2014-01-11 15:05:45 -06:00
test	Move #glob_include? from core_ext to entry_filter	2014-01-08 20:24:21 -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 #1928 [ci skip]	2014-01-11 15:32:12 -08:00
LICENSE	convert to use rakegem	2010-04-21 13:55:01 -07:00
README.markdown	first pass at vision	2014-01-12 11:57:11 -08: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 perfect for personal or project sites. Think of it sort of like a file-based CMS, except without all the complexity. Jekyll takes your content, runs it through Markdown converters and Liquid templates, and spits out a complete, static website suitable for serving with Apache, Nginx 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 on GitHub.

Philosophy

Jekyll does what you tell it to do, no more, no less. It doesn't try to outsmart users by making bold assumptions or burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.

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.