dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
773 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
Matt Rogers bab29f64f7 Look for plugins under the source directory 
When generating the site, Jekyll will now look for plugins under the
source directory by default. The plugin location can still be changed in
_config.yml
 		2012-10-12 22:43:20 -05:00
bin Merge branch 'master' of https://github.com/daneharrigan/jekyll into daneharrigan-master 2012-04-23 16:48:18 -07:00
features Allow a custom 'layouts' directory 2012-05-30 21:39:43 -04:00
lib Look for plugins under the source directory 2012-10-12 22:43:20 -05:00
test Cleanup for RDiscount TOC support. Closes #333. 2012-04-23 16:15:55 -07:00
.gitignore Update and clarify dependencies. 2011-11-26 18:48:51 -08:00
.travis.yml Update travis-ci configuration file 2012-06-12 00:35:21 +01:00
Gemfile Gemfile to help install the dependencies 2011-03-06 01:46:00 -08:00
History.txt Update History. 2012-04-23 17:23:11 -07:00
LICENSE convert to use rakegem 2010-04-21 13:55:01 -07:00
README.textile Merge remote-tracking branch 'jbw/ruby-v1.9' into devel 2011-04-23 18:08:34 +08:00
Rakefile No longer need pygments locally 2012-05-31 16:06:49 -04: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 Swap out albino for pygments.rb 2012-05-31 15:51:34 -04: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)
* Pygments: Syntax highlighting (Python)

h2. Developer Dependencies

* Shoulda: Test framework (Ruby)
* RR: Mocking (Ruby)
* RedGreen: Nicer test output (Ruby)
* RDiscount: Discount Markdown Processor (Ruby)

h2. License

See LICENSE.