Skip to content
A Jekyll theme for writing documentation websites
Branch: master
Clone or download
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 Only show project version if it has been set Jun 5, 2018
_layouts Remove Bootstrap's minified JS Nov 2, 2016
assets Prevent images from overflow Sep 30, 2018
.editorconfig Add Makefile for... Laziness Oct 31, 2016
.gitignore
Gemfile Initial commit Oct 31, 2016
LICENSE.md
README.md Update README.md Jun 26, 2017
_config.yml Rearrange files to allow GH-pages to build it properly May 4, 2017
index.md Update index with better theme into + fix a link Oct 5, 2018
jekyll-docs-theme.gemspec
screenshot.png Add screenshot Nov 15, 2016

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.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.