README.textile 2.23 KB
Newer Older
Tom Preston-Werner's avatar
Tom Preston-Werner committed
1
h1. Jekyll
Tom Preston-Werner's avatar
Tom Preston-Werner committed
2

Parker Moore's avatar
Parker Moore committed
3
!https://travis-ci.org/mojombo/jekyll.png?branch=master!:https://travis-ci.org/mojombo/jekyll
Brian Kim's avatar
Brian Kim committed
4
"!https://codeclimate.com/github/mojombo/jekyll.png!":https://codeclimate.com/github/mojombo/jekyll
Parker Moore's avatar
Parker Moore committed
5

6 7
By Tom Preston-Werner, Nick Quaranto, and many awesome contributors!

8
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.
9

10
h2. Getting Started
11

Arlen Cuss's avatar
Arlen Cuss committed
12 13
* "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/
14
* Take a gander at some existing "Sites":http://wiki.github.com/mojombo/jekyll/sites
Arlen Cuss's avatar
Arlen Cuss committed
15
* Fork and "Contribute":https://github.com/mojombo/jekyll/blob/master/CONTRIBUTING.md your own modifications
16
* Have questions? Post them on the "Mailing List":http://groups.google.com/group/jekyll-rb
17

18
h2. Diving In
19

Arlen Cuss's avatar
Arlen Cuss committed
20 21 22 23 24 25
* "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
26

27 28 29 30
h2. Runtime Dependencies

* Classifier: Generating related posts (Ruby)
* Directory Watcher: Auto-regeneration of sites (Ruby)
31 32 33
* Kramdown: Markdown-superset converter (Ruby)
* Liquid: Templating system (Ruby)
* Maruku: Default markdown engine (Ruby)
34 35 36

h2. Developer Dependencies

37
* RDiscount: Discount Markdown Processor (Ruby)
38 39 40 41
* RedCloth: Textile support (Ruby)
* RedGreen: Nicer test output (Ruby)
* RR: Mocking (Ruby)
* Shoulda: Test framework (Ruby)
42

43
h2. License
Tom Preston-Werner's avatar
Tom Preston-Werner committed
44

Jonathan Roes's avatar
Jonathan Roes committed
45
See "LICENSE":https://github.com/mojombo/jekyll/blob/master/LICENSE.