Jekyll is a blog-aware, static site generator in Ruby
Ruby CSS Shell CoffeeScript
Pull request Compare This branch is 4929 commits behind jekyll:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
features
lib
script
site
test
.gitignore
.travis.yml
CONTRIBUTING.markdown
Gemfile
History.markdown
LICENSE
README.markdown
Rakefile
cucumber.yml
jekyll.gemspec

README.markdown

Jekyll

Gem Version

Build Status Code Climate Dependency Status Coverage Status

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

Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind GitHub Pages, which you can use to host sites right from your GitHub repositories.

Philosophy

Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.

Getting Started

Diving In

Runtime Dependencies

  • Commander: Command-line interface constructor (Ruby)
  • Colorator: Colorizes command line output (Ruby)
  • Classifier: Generating related posts (Ruby)
  • Directory Watcher: Auto-regeneration of sites (Ruby)
  • Liquid: Templating system (Ruby)
  • Maruku: Default markdown engine (Ruby)
  • Pygments.rb: Syntax highlighting (Ruby/Python)
  • RedCarpet: Markdown engine (Ruby)
  • Safe YAML: YAML Parser built for security (Ruby)

Developer Dependencies

  • Kramdown: Markdown-superset converter (Ruby)
  • Launchy: Cross-platform file launcher (Ruby)
  • RDiscount: Discount Markdown Processor (Ruby)
  • RedCloth: Textile support (Ruby)
  • RedGreen: Nicer test output (Ruby)
  • RR: Mocking (Ruby)
  • Shoulda: Test framework (Ruby)
  • SimpleCov: Coverage framework (Ruby)

License

See LICENSE.