Go to file

Parker Moore 5cfbeeb5d9 Our CI server runs bundle install already. Don't need to do it in script/cibuild.		2014-03-02 13:53:47 -05:00
bin	Line -q up with the other flags. [ci skip]	2014-01-03 21:14:55 -08:00
docs/jp	Move CONTRIBUTING and README JP translations to docs/jp/ #2081	2014-02-24 18:59:48 -05:00
features	Update #relative_path for _drafts and add tests.	2014-02-11 12:48:34 +00:00
lib	Bring in jekyll-sass-converter	2014-02-28 21:20:20 -05:00
script	Our CI server runs bundle install already. Don't need to do it in script/cibuild.	2014-03-02 13:53:47 -05:00
site	Point migration docs link to the actual docs	2014-03-01 17:20:25 -05:00
test	Clean out Sass tests that we don't need anymore.	2014-02-28 21:38:07 -05:00
.gitignore	Remove duplicate	2013-08-21 23:08:26 +02:00
.travis.yml	Merge pull request #2045 from jekyll/kill-1-9-2	2014-02-14 12:46:07 -06:00
CONTRIBUTING.markdown	mojombo/jekyll ~> jekyll/jekyll	2013-12-11 17:44:33 -05:00
Gemfile	Yarp seems to be eff'd.	2014-01-31 00:22:21 -05:00
History.markdown	Update history to reflect merge of #2098 [ci skip]	2014-02-28 21:37:02 -05:00
LICENSE	Update license with all years since 2008.	2014-02-17 12:17:25 -05:00
README.markdown	Reorder Maruku and Kramdown	2014-02-15 23:12:31 +01:00
Rakefile	Rip out now-obsolete pieces of gemspec.	2014-02-24 16:17:41 -05:00
cucumber.yml	Change default format to pretty and create travis profile	2013-03-04 03:12:31 +01:00
jekyll.gemspec	Choose jekyll-sass-converter 1.0.0.rc1	2014-02-28 21:12:00 -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, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind GitHub Pages, which you can use to host sites right from your GitHub repositories.

Philosophy

Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it 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)
Kramdown: Default Markdown engine (Ruby)
Liquid: Templating system (Ruby)
Pygments.rb: Syntax highlighting (Ruby/Python)
RedCarpet: Markdown engine (Ruby)
Safe YAML: YAML Parser built for security (Ruby)

Developer Dependencies

Launchy: Cross-platform file launcher (Ruby)
Maruku: Markdown-superset interpreter (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.