Jekyll Theme Docs

Bootstrap theme to host documentation. SEO optimized, Google CSE, Formspree and Disqus comments.

Installation

gem "jekyll-theme-docs"

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

theme: jekyll-theme-docs

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-docs

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jekyll-theme-docs/jekyll-theme-docs.github.io. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

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

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.

License

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