# just-the-docs/just-the-docs

A modern, high customizable, responsive Jekyll theme for documentation with built-in search.

Repository: https://github.com/just-the-docs/just-the-docs
Canonical: https://ross.abutalabs.com/products/just-the-docs
Homepage: https://just-the-docs.com
Language: SCSS
License: MIT
License Family: permissive
Topics: jekyll, jekyll-theme, documentation, github-pages
Last push: 2026-08-25T21:30:32+00:00

## Health v2 (maintenance only)
Score: 88/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 67, longevity 100
- inputs: {"age_days": 3220, "days_push": 8, "days_rel": 222, "gap_med": 10.5, "n_releases_24m": 7}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 9140, forks 3789 (observed 2026-08-28T04:10:28.588639+00:00)

## What it is
Just the Docs is a modern, highly customizable, responsive Jekyll theme designed for building documentation websites, with built-in client-side search. It is distributed as a Ruby gem and can be easily hosted on GitHub Pages with minimal dependencies.

## Use cases
- create a documentation website for an open-source project
- host project docs on GitHub Pages
- build a static docs site with built-in search
- generate a responsive documentation site from Markdown files
- customize a Jekyll theme for a knowledge base
- add a navigation sidebar and search to a Jekyll site

## When to choose
- you want a documentation site hosted for free on GitHub Pages
- you write docs in Markdown and want minimal tooling and dependencies
- you need built-in search, navigation sidebar, and heading anchors out of the box
- you want a highly customizable SCSS-based theme with light/dark color schemes

## When to avoid
- you need a dynamic, server-rendered application rather than a static site
- your stack is not Ruby/Jekyll-based (e.g., you prefer Node-based static site generators)
- you need advanced full-text search features like faceting or analytics beyond client-side search
- you want a general-purpose blog or marketing site theme rather than docs-focused layout

## Facets
- artifact type: plugin
- maturity: active
- function: static-site-generator, search-engine, ui-components, templating, documentation
- domain: documentation, web-development, frontend
- platform: ruby, self-hosted
- tags: jekyll-theme, github-pages, static-site, docs-theme, scss, mermaid-diagrams, responsive-design, web-server

## Member repositories
- just-the-docs/just-the-docs (main) score 88

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:10:28.588639+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-29T17:23:24.637842+00:00, confidence not recorded.
  - readme: https://github.com/just-the-docs/just-the-docs (fetched 2026-08-28T04:10:28.588639+00:00, sha 53e5f1d16661)
  - homepage: https://just-the-docs.com (fetched 2026-08-29T08:23:43.965905+00:00, sha e76d25afcde0)
  - site_page: https://just-the-docs.com/docs/configuration (fetched 2026-08-29T08:23:43.968732+00:00, sha 1fdeb8314dd4)
  - site_page: https://just-the-docs.com/docs/ui-components (fetched 2026-08-29T08:23:43.970806+00:00, sha d65a94e4134d)
  - site_page: https://just-the-docs.com/docs/ui-components/typography (fetched 2026-08-29T08:23:43.972444+00:00, sha 91468e82fb2f)
  - site_page: https://just-the-docs.com/docs/ui-components/buttons (fetched 2026-08-29T08:23:43.974083+00:00, sha 404e2cedffec)
  - site_page: https://just-the-docs.com/docs/ui-components/labels (fetched 2026-08-29T08:23:43.975604+00:00, sha 6ae1e9983123)
  - site_page: https://just-the-docs.com/docs/ui-components/tables (fetched 2026-08-29T08:23:43.977123+00:00, sha 407ffba7c0e6)
  - site_page: https://just-the-docs.com/docs/ui-components/lists (fetched 2026-08-29T08:23:43.978720+00:00, sha cdbe6abb56b5)
  - site_page: https://just-the-docs.com/docs/ui-components/code (fetched 2026-08-29T08:23:43.980220+00:00, sha b92cdf444879)
- Data as of 2026-08-30T08:39:29.467469+00:00.