dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
825 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
Nick Quaranto 0776078487 If we're going to use Launchy, let's use Dir.chdir 2013-01-01 19:46:56 -05:00
bin Merge branch 'master' of https://github.com/enure/jekyll into enure-master 2012-12-31 14:22:24 -08:00
features Allow a custom 'layouts' directory 2012-05-30 21:39:43 -04:00
lib Merge pull request #651 from alagu/master 2012-12-31 18:24:43 -08:00
site Update site dir with contents of #583 at rev cb19367. 2012-12-31 12:48:04 -08:00
test Add testcases for YAML syntax error and non UTF-8 encoding 2012-12-30 02:39:02 +02:00
.gitignore A better way to preview and release the Jekyll site. 2012-12-26 15:13:57 -07: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-12-31 16:41:38 -08:00
LICENSE convert to use rakegem 2010-04-21 13:55:01 -07:00
README.textile Update Dependencies in Readme, alphabetize 2012-12-31 03:14:30 +01:00
Rakefile If we're going to use Launchy, let's use Dir.chdir 2013-01-01 19:46:56 -05: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 Use Launchy for cross platform site:preview. Thx @ixti. 2012-12-29 15:29:56 -08: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

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