Go to file

Parker Moore ed7fb46b96 Update history to reflect merge of #1741		2013-11-21 15:57:03 -05:00
bin	Merge pull request #1669 from albertogg/jekyll-import-arguments	2013-11-10 19:44:20 -08:00
features	add test case for variable include tag in a loop	2013-11-14 20:47:42 +01:00
lib	Use Pathname#to_s instead of Pathname#to_path	2013-11-16 13:12:59 -05:00
script	Add a bootstrap script	2013-01-22 23:10:51 +00:00
site	Update link to example Rakefile to point to specific commit.	2013-11-20 21:45:05 -08:00
test	Extract Site#filter_entries into its own class	2013-11-04 21:35:13 -06:00
.gitignore	Remove duplicate	2013-08-21 23:08:26 +02:00
.travis.yml	Enable Travis' bundle caching	2013-11-19 17:32:11 +01:00
CONTRIBUTING.markdown	Update CONTRIBUTING docs for better PRs.	2013-09-12 10:48:42 -04:00
Gemfile	Add in test plugin for inclusion.	2013-10-04 15:49:47 -04:00
History.markdown	Update history to reflect merge of #1741	2013-11-21 15:57:03 -05:00
LICENSE	convert to use rakegem	2010-04-21 13:55:01 -07:00
README.markdown	Build status badge in README refers to master branch.	2013-10-16 12:54:25 -07: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	Prep for the 1.3.0 release	2013-11-03 21:46:02 -06: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.