jekyll

Go to file

Parker Moore 9414281521 Merge pull request #750 from mojombo/update-travis-config Updating travis configuration to explicitly run 'rake' behind bundle exec		2013-01-11 16:52:00 -08:00
bin	merge lastest from mojombo/jekyll master	2013-01-11 12:23:53 +01:00
features	Allow a custom 'layouts' directory	2012-05-30 21:39:43 -04:00
lib	merge lastest from mojombo/jekyll master	2013-01-11 12:23:53 +01:00
site	Kill sites page on the new docs site. It's a moshpit of slightly useful content, and really there should be a featured site list or an actual directory separate from the docs site	2013-01-01 19:57:06 -05:00
test	removed extraneous whitespace in test_site.rb	2013-01-11 15:54:57 -08:00
.gitignore	A better way to preview and release the Jekyll site.	2012-12-26 15:13:57 -07:00
.ruby-version	Added support for .ruby-version to ensure congruent dev environment	2013-01-02 19:59:20 -05:00
.travis.yml	Revert "Specific patch version of 1.9.3: 362."	2013-01-11 16:45:17 -08:00
CONTRIBUTING.md	Add a CONTRIBUTING file	2013-01-10 21:44:08 -06:00
Gemfile	Gemfile to help install the dependencies	2011-03-06 01:46:00 -08:00
History.txt	Updated history to reflected merged PRs, #745 and #685 .	2013-01-11 16:17:03 -08:00
LICENSE	convert to use rakegem	2010-04-21 13:55:01 -07:00
README.textile	Added Travis CI badge to README	2013-01-11 15:55:14 -08:00
Rakefile	If we're going to use Launchy, let's use Dir.chdir	2013-01-01 19:46:56 -05:00
cucumber.yml	fixes problem in issue 64 fix where pages like about.md would be output as about.md/index.html. provides the output extension as a method rather than replacing the ext attribute as part of transform	2010-02-27 09:27:36 +00:00
jekyll.gemspec	Changes based on @mojombo's feedback	2013-01-08 23:17:06 +01:00

README.textile

h1. Jekyll

!https://travis-ci.org/mojombo/jekyll.png?branch=master!:https://travis-ci.org/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://wiki.github.com/mojombo/jekyll/install the gem
* Read up about its "Usage":http://wiki.github.com/mojombo/jekyll/usage and "Configuration":http://wiki.github.com/mojombo/jekyll/configuration
* Take a gander at some existing "Sites":http://wiki.github.com/mojombo/jekyll/sites
* Fork and "Contribute":http://wiki.github.com/mojombo/jekyll/contribute your own modifications
* Have questions? Post them on the "Mailing List":http://groups.google.com/group/jekyll-rb

h2. Diving In

* "Migrate":http://wiki.github.com/mojombo/jekyll/blog-migrations from your previous system
* Learn how the "YAML Front Matter":http://wiki.github.com/mojombo/jekyll/yaml-front-matter works
* Put information on your site with "Template Data":http://wiki.github.com/mojombo/jekyll/template-data
* Customize the "Permalinks":http://wiki.github.com/mojombo/jekyll/permalinks your posts are generated with
* Use the built-in "Liquid Extensions":http://wiki.github.com/mojombo/jekyll/liquid-extensions to make your life easier

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)
* Pygments: Syntax highlighting (Python)

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.