mirror of
https://github.com/jekyll/jekyll.git
synced 2026-02-01 02:05:35 -05:00
bc954683cb
By now, I have almost entirely rewritten Jekyll with the help of our awesome contributors. Taking a look at the contributions graphs GitHub provides, I have to date pushed 1,452 commits to master with 24,991 additions and 17,330 deletions. In contrast, Tom Preston-Werner has pushed 295 commits and 13,461 additions and 6,806 deletions. I don't need to have my name all over it, but I think I have worked hard enough over the last 21 months to deserve to put my name alongside Tom's and Nick's. The lovely thing about version control is that changes can always be reverted. Thanks for launching this great product, @mojombo and @qrush. I hope I haven't let you down.
36 lines
2.4 KiB
Markdown
36 lines
2.4 KiB
Markdown
# [Jekyll](http://jekyllrb.com/)
|
||
|
||
[](https://rubygems.org/gems/jekyll)
|
||
[](https://travis-ci.org/jekyll/jekyll)
|
||
[](https://codeclimate.com/github/jekyll/jekyll)
|
||
[](https://gemnasium.com/jekyll/jekyll)
|
||
|
||
By Tom Preston-Werner, Nick Quaranto, Parker Moore, and many [awesome contributors](https://github.com/jekyll/jekyll/graphs/contributors)!
|
||
|
||
Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind [GitHub Pages](http://pages.github.com), which you can use to host sites right from your GitHub repositories.
|
||
|
||
## Philosophy
|
||
|
||
Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.
|
||
|
||
## Getting Started
|
||
|
||
* [Install](http://jekyllrb.com/docs/installation/) the gem
|
||
* Read up about its [Usage](http://jekyllrb.com/docs/usage/) and [Configuration](http://jekyllrb.com/docs/configuration/)
|
||
* Take a gander at some existing [Sites](https://wiki.github.com/jekyll/jekyll/sites)
|
||
* Fork and [Contribute](http://jekyllrb.com/docs/contributing/) your own modifications
|
||
* Have questions? Check out [`#jekyll` on irc.freenode.net](https://botbot.me/freenode/jekyll/).
|
||
|
||
## Diving In
|
||
|
||
* [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system
|
||
* Learn how the [YAML Front Matter](http://jekyllrb.com/docs/frontmatter/) works
|
||
* Put information on your site with [Variables](http://jekyllrb.com/docs/variables/)
|
||
* Customize the [Permalinks](http://jekyllrb.com/docs/permalinks/) your posts are generated with
|
||
* Use the built-in [Liquid Extensions](http://jekyllrb.com/docs/templates/) to make your life easier
|
||
* Use custom [Plugins](http://jekyllrb.com/docs/plugins/) to generate content specific to your site
|
||
|
||
## License
|
||
|
||
See [LICENSE](https://github.com/jekyll/jekyll/blob/master/LICENSE).
|