A Jekyll theme for writing documentation websites
Branch: master
Clone or download
Pull request Compare This branch is 3 commits behind allejo:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_layouts
assets
.editorconfig
.gitignore
Gemfile
LICENSE.md
README.md
_config.yml
index.md
jekyll-docs-theme.gemspec
screenshot.png

README.md

Jekyll Docs Theme

This is a Jekyll theme based on mistic100's modification 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

Installation

Fork this project

-or-

Add this line to your Jekyll site's Gemfile:

gem "jekyll-docs-theme"

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

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 bundle exec jekyll serve and open your browser at http://localhost:4000.

License

The theme is available as open source under the terms of the MIT License.