| # [Jekyll](https://jekyllrb.com/) |
| |
| [][ruby-gems] |
| [][travis] |
| [][appveyor] |
| [][coverage] |
| [][codeclimate] |
| [][gemnasium] |
| [][hakiri] |
| |
| [ruby-gems]: https://rubygems.org/gems/jekyll |
| [gemnasium]: https://gemnasium.com/jekyll/jekyll |
| [codeclimate]: https://codeclimate.com/github/jekyll/jekyll |
| [coverage]: https://codeclimate.com/github/jekyll/jekyll/coverage |
| [hakiri]: https://hakiri.io/github/jekyll/jekyll/master |
| [travis]: https://travis-ci.org/jekyll/jekyll |
| [appveyor]: https://ci.appveyor.com/project/jekyll/jekyll/branch/master |
| |
| 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](https://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. |
| |
| ## Having trouble with OS X/macOS? |
| |
| See: https://jekyllrb.com/docs/troubleshooting/ |
| |
| ## Getting Started |
| |
| * [Install](https://jekyllrb.com/docs/installation/) the gem |
| * Read up about its [Usage](https://jekyllrb.com/docs/usage/) and [Configuration](https://jekyllrb.com/docs/configuration/) |
| * Take a gander at some existing [Sites](https://wiki.github.com/jekyll/jekyll/sites) |
| * [Fork](https://github.com/jekyll/jekyll/fork) and [Contribute](https://jekyllrb.com/docs/contributing/) your own modifications |
| * Have questions? Check out our official forum community [Jekyll Talk](https://talk.jekyllrb.com/) or [`#jekyll` on irc.freenode.net](https://botbot.me/freenode/jekyll/) |
| |
| ## Code of Conduct |
| |
| In order to have a more open and welcoming community, Jekyll adheres to a |
| [code of conduct](CONDUCT.markdown) adapted from the Ruby on Rails code of |
| conduct. |
| |
| Please adhere to this code of conduct in any interactions you have in the |
| Jekyll community. It is strictly enforced on all official Jekyll |
| repositories, websites, and resources. If you encounter someone violating |
| these terms, please let a maintainer ([@parkr](https://github.com/parkr), [@envygeeks](https://github.com/envygeeks), [@mattr-](https://github.com/mattr-), or [@alfredxing](https://github.com/alfredxing)) know and we will address it as soon as possible. |
| |
| ## Diving In |
| |
| * [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system |
| * Learn how the [YAML Front Matter](https://jekyllrb.com/docs/frontmatter/) works |
| * Put information on your site with [Variables](https://jekyllrb.com/docs/variables/) |
| * Customize the [Permalinks](https://jekyllrb.com/docs/permalinks/) your posts are generated with |
| * Use the built-in [Liquid Extensions](https://jekyllrb.com/docs/templates/) to make your life easier |
| * Use custom [Plugins](https://jekyllrb.com/docs/plugins/) to generate content specific to your site |
| |
| ## License |
| |
| See the [LICENSE](https://github.com/jekyll/jekyll/blob/master/LICENSE) file. |
