dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
530 Commits 2 Branches 2 Tags 21 MiB
Ruby 70.6%
Gherkin 23.1%
JavaScript 3.8%
HTML 1.2%
Shell 0.8%
Other 0.4%
Go to file
Scott Hill f6acbb869e Changed the date used by Jekyll to be the date the post was authored on instead of the date it was created. If the latter is used on an imported post, it gets the import date instead of the date the post was originally written. 2010-08-06 01:26:32 -07:00
bin Merge remote branch 'darwin/site_url_from_cmdline' 2010-06-22 15:33:06 -07:00
features Ruby 1.9 compat fix in features. Fixes #141. 2010-04-21 14:41:01 -07:00
lib Changed the date used by Jekyll to be the date the post was authored on instead of the date it was created. If the latter is used on an imported post, it gets the import date instead of the date the post was originally written. 2010-08-06 01:26:32 -07:00
test Merge remote branch 'christianhellsten/master' into next 2010-06-22 16:01:48 -07:00
.gitignore creating a Site with an invalid Markdown processor fails sooner and gives a better error message 2009-06-23 08:10:33 -04:00
History.txt Release 0.6.2 2010-06-25 15:56:57 -07:00
LICENSE convert to use rakegem 2010-04-21 13:55:01 -07:00
README.textile convert to use rakegem 2010-04-21 13:55:01 -07:00
Rakefile Fix Rakefile release task (tag pushing was missing origin) 2010-06-23 15:58:09 -07: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 Release 0.6.2 2010-06-25 15:56:57 -07:00

README.textile 

h1. 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

* RedCloth: Textile support (Ruby)
* Liquid: Templating system (Ruby)
* Classifier: Generating related posts (Ruby)
* Maruku: Default markdown engine (Ruby)
* Directory Watcher: Auto-regeneration of sites (Ruby)
* Open4: Talking to pygments for syntax highlighting (Ruby)
* Pygments: Syntax highlighting (Python)

h2. Developer Dependencies

* Shoulda: Test framework (Ruby)
* RR: Mocking (Ruby)
* RedGreen: Nicer test output (Ruby)

h2. License

See LICENSE.