Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 42 lines (29 sloc) 2.037 kb
bffdeee @mojombo rename to Jekyll
mojombo authored
1 h1. Jekyll
d189e05 @mojombo first commit
mojombo authored
2
1324535 @mojombo update readme for new workflow
mojombo authored
3 By Tom Preston-Werner, Nick Quaranto, and many awesome contributors!
4
5a1d736 @qrush Updating README with links to the wiki
qrush authored
5 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.
1324535 @mojombo update readme for new workflow
mojombo authored
6
5a1d736 @qrush Updating README with links to the wiki
qrush authored
7 h2. Getting Started
3a21a0b @mojombo break long lines in readme
mojombo authored
8
5a1d736 @qrush Updating README with links to the wiki
qrush authored
9 * "Install":http://wiki.github.com/mojombo/jekyll/install the gem
10 * Read up about its "Usage":http://wiki.github.com/mojombo/jekyll/usage and "Configuration":http://wiki.github.com/mojombo/jekyll/configuration
11 * Take a gander at some existing "Sites":http://wiki.github.com/mojombo/jekyll/sites
12 * Fork and "Contribute":http://wiki.github.com/mojombo/jekyll/contribute your own modifications
3bc4f59 @qrush Updating readme with links to the mailing list
qrush authored
13 * Have questions? Post them on the "Mailing List":http://groups.google.com/group/jekyll-rb
3a21a0b @mojombo break long lines in readme
mojombo authored
14
5a1d736 @qrush Updating README with links to the wiki
qrush authored
15 h2. Diving In
3a21a0b @mojombo break long lines in readme
mojombo authored
16
5a1d736 @qrush Updating README with links to the wiki
qrush authored
17 * "Migrate":http://wiki.github.com/mojombo/jekyll/blog-migrations from your previous system
18 * Learn how the "YAML Front Matter":http://wiki.github.com/mojombo/jekyll/yaml-front-matter works
19 * Put information on your site with "Template Data":http://wiki.github.com/mojombo/jekyll/template-data
20 * Customize the "Permalinks":http://wiki.github.com/mojombo/jekyll/permalinks your posts are generated with
21 * Use the built-in "Liquid Extensions":http://wiki.github.com/mojombo/jekyll/liquid-extensions to make your life easier
fae0928 @mojombo refine and move contribution section of readme to bottom
mojombo authored
22
60fed24 @mojombo better deps in readme. fixes #87. fixes #88
mojombo authored
23 h2. Runtime Dependencies
24
25 * RedCloth: Textile support (Ruby)
26 * Liquid: Templating system (Ruby)
27 * Classifier: Generating related posts (Ruby)
28 * Maruku: Default markdown engine (Ruby)
29 * Directory Watcher: Auto-regeneration of sites (Ruby)
30 * Pygments: Syntax highlighting (Python)
31
32 h2. Developer Dependencies
33
34 * Shoulda: Test framework (Ruby)
35 * RR: Mocking (Ruby)
36 * RedGreen: Nicer test output (Ruby)
75b93e3 @jbw RDiscount is required to run the test suite.
jbw authored
37 * RDiscount: Discount Markdown Processor (Ruby)
d948e0d @qrush Removing RedCloth gem lock and adding notes in for deps
qrush authored
38
574637a @mojombo flesh out readme a little bit
mojombo authored
39 h2. License
d189e05 @mojombo first commit
mojombo authored
40
03cb12a @mojombo convert to use rakegem
mojombo authored
41 See LICENSE.
Something went wrong with that request. Please try again.