jekyll

Go to file

Anand Narayan 7e79b9df92 added a plus to permalink		2013-06-15 23:18:31 +05:30
bin	Fix #1173	2013-06-06 16:24:04 +02:00
features	Merge pull request #1151 from jpiasetz/refactors-steps	2013-06-08 10:46:13 -07:00
lib	removed cgi unescape in page destination	2013-06-15 18:38:14 +05:30
script	Add a bootstrap script	2013-01-22 23:10:51 +00:00
site	Merge pull request #1208 from mojombo/imageoptim	2013-06-13 05:23:10 -07:00
test	added a plus to permalink	2013-06-15 23:18:31 +05:30
.gitignore	ignore .ruby-version	2013-03-13 18:47:07 +00:00
.travis.yml	Compliant with Ruby 2.0.0	2013-04-26 21:20:48 +02:00
CONTRIBUTING.md	When one clones one's fork of Jekyll, one should not use the readonly git:// protocol. Instead, use SSH.	2013-04-26 19:09:11 +02:00
Gemfile	Explicitly require HTTPS rubygems source	2013-02-27 20:28:09 -05:00
History.markdown	Update history to reflect merge of #1210 .	2013-06-13 14:58:39 +02:00
LICENSE	convert to use rakegem	2010-04-21 13:55:01 -07:00
README.textile	Update README links.	2013-05-06 10:01:51 +10: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.0.3	2013-06-07 21:02:13 +02:00

README.textile

h1. Jekyll

!https://travis-ci.org/mojombo/jekyll.png?branch=master!:https://travis-ci.org/mojombo/jekyll
"!https://codeclimate.com/github/mojombo/jekyll.png!":https://codeclimate.com/github/mojombo/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":http://pages.github.com, which you can use to host your project's page or blog right here from GitHub.

h2. Getting Started

* "Install":http://jekyllrb.com/docs/installation/ the gem
* Read up about its "Usage":http://jekyllrb.com/docs/usage/ and "Configuration":http://jekyllrb.com/docs/configuration/
* Take a gander at some existing "Sites":http://wiki.github.com/mojombo/jekyll/sites
* Fork and "Contribute":https://github.com/mojombo/jekyll/blob/master/CONTRIBUTING.md your own modifications
* Have questions? Post them on the "Mailing List":http://groups.google.com/group/jekyll-rb

h2. Diving In

* "Migrate":http://jekyllrb.com/docs/migrations/ from your previous system
* Learn how the "YAML Front Matter":http://jekyllrb.com/docs/frontmatter/ works
* Put information on your site with "Variables":http://jekyllrb.com/docs/variables/
* Customize the "Permalinks":http://jekyllrb.com/docs/permalinks/ your posts are generated with
* Use the built-in "Liquid Extensions":http://jekyllrb.com/docs/templates/ to make your life easier
* Use custom "Plugins":http://jekyllrb.com/docs/plugins/ to generate content specific to your site

h2. Runtime Dependencies

* 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)

h2. Developer Dependencies

* RDiscount: Discount Markdown Processor (Ruby)
* RedCloth: Textile support (Ruby)
* RedGreen: Nicer test output (Ruby)
* RR: Mocking (Ruby)
* Shoulda: Test framework (Ruby)

h2. License

See "LICENSE":https://github.com/mojombo/jekyll/blob/master/LICENSE.