dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
935 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
Tom Bell 507f1c3995 Add a bootstrap script 2013-01-22 23:10:51 +00:00
bin Rename migrate command to import 2013-01-11 00:32:39 +00:00
features Fixed failing Cucumber test 2013-01-12 22:25:55 -08:00
lib Merge pull request #684 from mattr-/issue-680. 2013-01-18 10:28:14 -05:00
script Add a bootstrap script 2013-01-22 23:10:51 +00:00
site Changed 'six' to 'some' on Sites page 2013-01-15 14:56:04 -08:00
test Merge pull request #684 from mattr-/issue-680. 2013-01-18 10:28:14 -05:00
.gitignore add the coverage directory to .gitignore 2013-01-16 22:22:33 -06:00
.ruby-version Added support for .ruby-version to ensure congruent dev environment 2013-01-02 19:59:20 -05:00
.travis.yml Revert "Specific patch version of 1.9.3: 362." 2013-01-11 16:45:17 -08:00
CONTRIBUTING.md Refine CONTRIBUTE with more detail and better formatting. 2013-01-17 12:38:27 -08:00
Gemfile Gemfile to help install the dependencies 2011-03-06 01:46:00 -08:00
History.txt Reflected merging of #671 in History. 2013-01-17 22:34:59 -05:00
LICENSE convert to use rakegem 2010-04-21 13:55:01 -07:00
README.textile Added Travis CI badge to README 2013-01-11 15:55:14 -08:00
Rakefile Remove the coverage rake task 2013-01-16 22:15:45 -06:00
cucumber.yml Added html_report profile to cucumber 2013-01-12 21:55:59 -08:00
jekyll.gemspec Added note in gemspec for easy extraction of dev dependencies to migrator gem. 2013-01-18 10:35:21 -05:00

README.textile 

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.