Contents

# Jekyll Docs Theme

> This is a [Jekyll theme](https://github.com/allejo/jekyll-docs-theme) based on [mistic100's modification](https://github.com/mistic100/jekyll-docs-theme) of the official Bootstrap documentation from a few years back.

Jekyll Docs Theme is provided as a theme for writing documentation for your projects instead of having a single large README file or several markdown files stored in a not so user-friendly manner.

This theme is still in development but is kept fairly stable; just note, there are a lot things yet to come.

![Theme Screenshot](https://raw.githubusercontent.com/allejo/jekyll-docs-theme/master/screenshot.png)

## Installation

Add this line to your Jekyll site's Gemfile:

```ruby
gem "jekyll-docs-theme"
```

And add this line to your Jekyll site's `_config.yml`:

```yaml
theme: jekyll-docs-theme
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install jekyll-docs-theme

## Development

To set up your environment to develop this theme, run `bundle install`.

To develop on this theme, run `rake preview` and open your browser at `http://localhost:4000`. The project website for this project uses this theme itself and is available in the `docs/` folder.

## License

The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
jekyll-docs-theme-0.1.1	README.md