Go to file
Matt Rogers 2dd98816d4 Remove duplication when generating list of entries to process
Posts and Drafts share the same logic to get the list of files to
process into objects when generating the site. Factor this logic into
its own method and use it when reading posts and reading drafts.
2013-03-05 19:06:20 -06:00
bin Normalize CLI options to match configuration expectations. 2013-03-03 18:23:02 -08:00
features Turn off debug mode on feature to suppress output. 2013-03-03 18:04:31 -08:00
lib Remove duplication when generating list of entries to process 2013-03-05 19:06:20 -06:00
script Add a bootstrap script 2013-01-22 23:10:51 +00:00
site Changed 'six' to 'some' on Sites page 2013-01-15 14:56:04 -08:00
test Fixed plugin test error. 2013-03-02 18:51:42 +01:00
.gitignore add the coverage directory to .gitignore 2013-01-16 22:22:33 -06:00
.ruby-version Fixed plugin test error. 2013-03-02 18:51:42 +01:00
.travis.yml Revert "Specific patch version of 1.9.3: 362." 2013-01-11 16:45:17 -08:00
CONTRIBUTING.md mention styleguide to new contributors 2013-02-10 17:19:22 +02:00
Gemfile Explicitly require HTTPS rubygems source 2013-02-27 20:28:09 -05:00
History.txt Merge branch 'drafts-fixup' 2013-03-03 18:57:36 -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 Add features:html task to Rakefile, use cucumber profiles 2013-03-04 03:13:06 +01:00
cucumber.yml Change default format to pretty and create travis profile 2013-03-04 03:12:31 +01:00
jekyll.gemspec Merge pull request #807 from mojombo/safeyaml-warnings 2013-02-19 03:01:27 -08: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.