# tomjoht/documentation-theme-jekyll

A Jekyll-based theme designed for documentation and help systems. See the link for detailed instructions on setting up and configuring everything.

Repository: https://github.com/tomjoht/documentation-theme-jekyll
Canonical: https://ross.abutalabs.com/products/documentation-theme-jekyll
Homepage: http://idratherbewriting.com/documentation-theme-jekyll/
Language: HTML
License: NOASSERTION
License Family: other
Last push: 2024-03-03T10:10:09+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 4219, "days_push": 913, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, no_license, no_readme
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1201, forks 1180 (observed 2026-08-28T04:03:58.215459+00:00)

## What it is
A Jekyll theme purpose-built for documentation sites and help systems, featuring multi-level sidebar navigation, search, content reuse, and special layouts like glossary, FAQ, and knowledge-base. It supports documenting multiple products on one site and is aimed at technical writers.

## Use cases
- build a documentation site for my product
- create a help system with sidebar navigation
- publish technical docs on GitHub Pages
- document multiple products on one site
- generate a knowledge base with search
- write API documentation with Jekyll

## When to choose
- you want a Jekyll-based docs site with rich navigation and search out of the box
- you need to document several products or versions in one site
- you're a technical writer comfortable with Markdown and YAML sidebars

## When to avoid
- you need a non-Jekyll stack or a JavaScript-based docs framework
- you expect active maintenance and frequent updates
- you need structured authoring like DITA with strict validation

## Facets
- artifact type: plugin
- maturity: maintenance
- function: documentation, static-site-generator, search-engine, templating
- domain: documentation, web-development, developer-tools
- platform: jvm, cross-platform
- tags: jekyll-theme, technical-writing, static-site, help-system, bootstrap, api-documentation, web-server

## Member repositories
- tomjoht/documentation-theme-jekyll (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:03:58.215459+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T06:20:43.486551+00:00, confidence not recorded.
  - homepage: http://idratherbewriting.com/documentation-theme-jekyll/ (fetched 2026-08-29T12:28:02.487107+00:00, sha 9711ff188323)
  - site_page: https://idratherbewriting.com/documentation-theme-jekyll/index.html (fetched 2026-08-29T12:28:02.490336+00:00, sha 3bcd96debcca)
  - site_page: https://idratherbewriting.com/documentation-theme-jekyll/news (fetched 2026-08-29T12:28:02.493518+00:00, sha b9fb1aaf2d1c)
  - site_page: https://idratherbewriting.com/documentation-theme-jekyll/mydoc_introduction.html (fetched 2026-08-29T12:28:02.495341+00:00, sha c22fda1c6057)
  - site_page: https://idratherbewriting.com/documentation-theme-jekyll/p1_landing_page.html (fetched 2026-08-29T12:28:02.497190+00:00, sha 5e2cec572e48)
  - site_page: https://idratherbewriting.com/documentation-theme-jekyll/p2_landing_page.html (fetched 2026-08-29T12:28:02.499226+00:00, sha efd34885af71)
  - site_page: https://idratherbewriting.com/documentation-theme-jekyll/mydoc_supported_features.html (fetched 2026-08-29T12:28:02.501036+00:00, sha a5ad2a68a720)
  - site_page: https://idratherbewriting.com/documentation-theme-jekyll/mydoc_about.html (fetched 2026-08-29T12:28:02.502841+00:00, sha 177b96b57c62)
  - site_page: https://idratherbewriting.com/documentation-theme-jekyll/mydoc_support.html (fetched 2026-08-29T12:28:02.504536+00:00, sha 2b80b49900ba)
- Data as of 2026-08-30T08:39:29.467469+00:00.