mirror of
https://github.com/jekyll/jekyll.git
synced 2026-01-30 09:18:11 -05:00
8fe25a6958
Directory_watcher consumed ~25% CPU on big Jekyll projects (depending on the number of watched files), since it polled for changes every second. Listen is easier on CPU, as it uses directory change notifications provided by OS (currently OS X and Linux), falling back to polling when they are not available.
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, which you can use to host your project's page or blog right here from GitHub.
Getting Started
- Install the gem
- Read up about its Usage and Configuration
- Take a gander at some existing Sites
- Fork and Contribute your own modifications
- Have questions? Check out
#jekyllon irc.freenode.net.
Diving In
- Migrate from your previous system
- Learn how the YAML Front Matter works
- Put information on your site with Variables
- Customize the Permalinks your posts are generated with
- Use the built-in Liquid Extensions to make your life easier
- Use custom Plugins to generate content specific to your site
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.