0.0
The project is in a healthy, maintained state
Fork of just-the-docs
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 2.3.5

Runtime

~> 3.0
~> 4.2.0
>= 12.3.1, < 13.1.0
~> 1.7
 Project Readme

fni-docs-theme

Forked from just-the-docs

Pertinent differences:

  • Nav generation has been moved to a plugin, lib/generators/nav-generator. This ensures the nav is only generated once and can be included

Installation

This theme is distributed as a Jekyll plugin, to install:

  • Add the plugin to your gemfile (recommend pinning a specific version):
group :jekyll_plugins do
  gem "fni-docs-theme", "0.4.2"
end

Add these lines to your Jekyll site's _config.yml:

theme: fni-docs-theme

plugins:
  - fni-docs-theme

Usage

View the documentation for usage information.

Publishing

This theme/plugin is published as fni-docs-theme to rubygems.org.

License

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