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.

Local Testing

> ./serve

Access the site at http://localhost:4000/fni-docs-theme/

Publishing

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

To publish a new version:

• Bump the version in the fni-docs-theme.gemspec
• Run the Publish Gem Github Action

License

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