Latest commit to the master branch
commit 4499df8033
![[image]](http://mowser.com/img?url=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F25c7c18223fb42a4c6ae1c8db6f50f9b%3Fs%3D140%26d%3Dhttps%3A%2F%2Fa248.e.akamai.net%2Fassets.github.com%252Fimages%252Fgravatars%252Fgravatar-140.png)
authored January 29, 2012
authored January 29, 2012
README.textile
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, which you can use to host your project’s page or blog right here from GitHub.
Getting Started
Install the gem Read up about its Usage and Configuration Take a gander at some existing Sites Fork and Contribute your own modifications Have questions? Post them on the Mailing List
Diving In
Migrate from your previous system Learn how the YAML Front Matter works Put information on your site with Template Data Customize the Permalinks your posts are generated with Use the built-in Liquid Extensions to make your life easier
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)
Developer Dependencies
Shoulda: Test framework (Ruby) RR: Mocking (Ruby) RedGreen: Nicer test output (Ruby) RDiscount: Discount Markdown Processor (Ruby)
License
See LICENSE.
![[image]](http://mowser.com/img?url=https%3A%2F%2Fa248.e.akamai.net%2Fassets.github.com%2Fimages%2Fmodules%2Fajax%2Fbig_spinner_336699.gif%3F1310104853)
Keyboard Shortcuts (see all)
Site wide shortcuts
- s
- Focus site search
- ?
- Bring up this help dialog
Commit list
- j
- Move selection down
- k
- Move selection up
- c or o or enter
- Open commit
- y
- Expand URL to its canonical form
Pull request list
- j
- Move selection down
- k
- Move selection up
- o or enter
- Open issue
Issues
- j
- Move selection down
- k
- Move selection up
- x
- Toggle selection
- o or enter
- Open issue
- I
- Mark selection as read
- U
- Mark selection as unread
- e
- Close selection
- y
- Remove selection from view
- c
- Create issue
- l
- Create label
- i
- Back to inbox
- u
- Back to issues
- /
- Focus issues search
Issues Dashboard
- j
- Move selection down
- k
- Move selection up
- o or enter
- Open issue
Network Graph
- ↠or h
- Scroll left
- → or l
- Scroll right
- ↑ or k
- Scroll up
- ↓ or j
- Scroll down
- t
- Toggle visibility of head labels
- shift ↠or shift h
- Scroll all the way left
- shift → or shift l
- Scroll all the way right
- shift ↑ or shift k
- Scroll all the way up
- shift ↓ or shift j
- Scroll all the way down
Source Code Browsing
- t
- Activates the file finder
- l
- Jump to line
- w
- Switch branch/tag
- y
- Expand URL to its canonical form
Markdown Cheat Sheet
Format Text
Headers
# This is an <h1> tag ## This is an <h2> tag ###### This is an <h6> tag
Text styles
*This text will be italic* _This will also be italic_ **This text will be bold** __This will also be bold__ *You **can** combine them*
Lists
Unordered
* Item 1 * Item 2 * Item 2a * Item 2b
Ordered
1. Item 1 2. Item 2 3. Item 3 * Item 3a * Item 3b
Miscellaneous
Images
 Format: 
Links
http://github.com - automatic! [GitHub](http://github.com)
Blockquotes
As Kanye West said: > We're living the future so > the present is our past.
Code Examples in Markdown
Syntax highlighting with GFM
```javascript
function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}
```
Or, indent your code 4 spaces
Here is a Python code example
without syntax highlighting:
def foo:
if not bar:
return true
Inline code for comments
I think you should use an `<addr>` element here instead.
You are viewing a mobilized version of this site...
View original page here
