Go to file

Thomas Torsney-Weir 627916bc54 force markdown match to match the full extension		2013-08-06 10:56:24 +02:00
bin	Create a default command to run help if there are no arguments but to fail with non-zero exit code if the command is invalid.	2013-07-22 10:04:45 +02:00
features	s/sitej/site/ props @benbalter	2013-07-22 14:57:44 +02:00
lib	force markdown match to match the full extension	2013-08-06 10:56:24 +02:00
script	Add a bootstrap script	2013-01-22 23:10:51 +00:00
site	Escape tag literal	2013-08-04 12:30:06 -07:00
test	add test to demonstrate issue with markdown extension parsing. adding mkd as an extension should not cause mkdn files to also be markdownified	2013-08-06 10:52:24 +02:00
.gitignore	ignore .ruby-version	2013-03-13 18:47:07 +00:00
.travis.yml	Remove duplicate period in travis message.	2013-07-01 17:41:11 +02:00
CONTRIBUTING.markdown	Standardized all text files on markdown and set all their extensions to the shortform	2013-07-06 13:51:33 -04:00
Gemfile	Explicitly require HTTPS rubygems source	2013-02-27 20:28:09 -05:00
History.markdown	Update history to reflect merge of #1373 .	2013-08-05 01:25:56 +02:00
LICENSE	convert to use rakegem	2010-04-21 13:55:01 -07:00
README.markdown	Update dependencies in README	2013-07-28 22:25:22 +02:00
Rakefile	Cleaned up code that generates History command.	2013-06-08 17:20:41 +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.1.2	2013-07-25 09:15:34 +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? Post them on the Mailing List

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: Markdown-superset converter (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

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.