mirror of
https://github.com/jekyll/jekyll.git
synced 2026-01-30 17:28:29 -05:00
3a9ca0a796
Add a drafts feature. This allows you to place draft posts into an _drafts folder in the site root while you're working on them, and then request that they be rendered as normal posts via a command line switch. Draft files should be named just like normal posts, except they must not contain the date prefix. When you're ready to make a post live, rename it with the date and move it to the proper place. To preview your drafts, run Jekyll with the `--drafts` switch. This will render all the posts with a date corresponding to the last time the file was modified.
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.