dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
655 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
Richard Jones 3389c6d508 Sometimes wp:post_name can be empty (e.g. when a post is still draft), in this case we make up an appropriate permalink_title that will be used as the filename. The importer can always rename the file later on, and at least the file is unlikely to have been overwritten by another draft on the same day. 2011-06-28 02:31:42 -07:00
bin Merge remote-tracking branch 'MattHall/redcarpet' 2011-05-29 21:38:34 -07:00
features Merge remote-tracking branch 'MattHall/redcarpet' 2011-05-29 21:38:34 -07:00
lib Sometimes wp:post_name can be empty (e.g. when a post is still draft), in this case we make up an appropriate permalink_title that will be used as the filename. The importer can always rename the file later on, and at least the file is unlikely to have been overwritten by another draft on the same day. 2011-06-28 02:31:42 -07:00
test Replace rdiscount filter with config-aware markdownify. 2011-05-31 14:40:21 -07:00
.gitignore Ignore .bundle dir. 2011-03-13 16:57:35 -07:00
Gemfile Gemfile to help install the dependencies 2011-03-06 01:46:00 -08:00
History.txt fixed redcarpet typo 2011-06-26 07:09:01 -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 Tests and specs run under 1.9. 2011-04-24 18:39:27 +08: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 Update gemspec so bundler installs work. 2011-05-30 11:18:15 -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)
* 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.