# ![Bunto](https://cloud.githubusercontent.com/assets/5073946/9288138/f4335fee-4337-11e5-9a28-068900097035.png)


> **Bunto** is a Web Application Framework which can be used as a simple, static site generator for personal, project, or organization sites. 

[![Gem Version](https://img.shields.io/gem/v/bunto.svg)][ruby-gems]
[![Build Status](https://travis-ci.org/bunto/bunto.svg?branch=ruby)][travis]
<!--
[![Test Coverage](https://codeclimate.com/github/bunto/bunto/badges/coverage.svg)][coverage]
[![Code Climate](https://codeclimate.com/github/bunto/bunto/badges/gpa.svg)][codeclimate]
[![Dependency Status](https://gemnasium.com/bunto/bunto.svg)][gemnasium]
[![Security](https://hakiri.io/github/bunto/bunto/ruby.svg)][hakiri]
-->

[ruby-gems]: https://rubygems.org/gems/bunto
<!--
[gemnasium]: https://gemnasium.com/bunto/bunto
[codeclimate]: https://codeclimate.com/github/bunto/bunto
[coverage]: https://codeclimate.com/github/bunto/bunto/coverage
[hakiri]: https://hakiri.io/github/bunto/bunto/ruby
-->
[travis]: https://travis-ci.org/bunto/bunto

By Suriyaa Kudo, Tom Preston-Werner and many [awesome contributors](https://github.com/bunto/bunto/graphs/contributors)!

Bunto is a Web Application Framework and can be used as a static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Bunto takes your content, renders HTML and CSS templates, and spits out a complete, static website ready to be served by Apache, hostSE, Nginx or another web server. Bunto is the engine behind [GitHub Pages](http://pages.github.com), which you can use to host sites right from your GitHub repositories.

## Getting Started

* [Install](https://bunto.github.io/bunto/docs/installation/) the gem
* Read up about its [Usage](https://bunto.github.io/docs/usage/) and [Configuration](https://bunto.github.io/docs/configuration/)
* Take a gander at some existing [Sites](https://wiki.github.com/bunto/bunto/sites)
* Fork and [Contribute](https://bunto.github.io/docs/contributing/) your own modifications
* Have questions? Check out our official forum community [Bunto Talk](https://bunto.github.io/talk/) or [`#bunto` on irc.freenode.net](https://botbot.me/freenode/bunto/)

## Code of Conduct

In order to have a more open and welcoming community, Bunto adheres to a
[code of conduct](CONDUCT.md) adapted from the Ruby on Rails code of
conduct.

Please adhere to this code of conduct in any interactions you have in the
Bunto community. It is strictly enforced on all official Bunto
repositories, websites, and resources. If you encounter someone violating
these terms, please let a maintainer (@SuriyaaKudoIsc) know
and we will address it as soon as possible.

## Diving In

* [Migrate](http://bunto.github.io/import/docs/home/) from your previous system
* Learn how the [YAML Front Matter](https://bunto.github.io/docs/frontmatter/) works
* Put information on your site with [Variables](https://bunto.github.io/docs/variables/)
* Customize the [Permalinks](https://bunto.github.io/docs/permalinks/) your posts are generated with
* Use the built-in [Liquid Extensions](https://bunto.github.io/docs/templates/) to make your life easier
* Use custom [Plugins](https://bunto.github.io/docs/plugins/) to generate content specific to your site

## License

See [LICENSE](https://github.com/bunto/bunto/blob/master/LICENSE).