# trulia/hologram

A markdown based documentation system for style guides.

Repository: https://github.com/trulia/hologram
Canonical: https://ross.abutalabs.com/products/hologram
Homepage: http://trulia.github.io/hologram
Language: Ruby
License: NOASSERTION
License Family: other
Last push: 2023-08-10T12:27:31+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": 4899, "days_push": 1119, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2167, forks 201 (observed 2026-08-28T04:06:21.454709+00:00)

## What it is
Hologram is a Ruby gem that parses specially formatted /*doc */ comments in CSS (and other source files) and generates static HTML style guide documentation. Documentation is written inline using YAML metadata and Markdown, with code blocks marked as examples rendered both as live HTML and as escaped code.

## Use cases
- generate a style guide from CSS comments
- build living style guide documentation for a design system
- document CSS components with markdown and html examples
- turn inline CSS documentation into a browsable website
- create a component library reference site

## When to choose
- you maintain a CSS codebase and want documentation living next to the styles
- you want a self-hosted, customizable style guide without a hosted service
- your team works in Ruby and prefers gem-based tooling

## When to avoid
- you use modern tooling like Storybook or Style Dictionary
- you need active development and recent community support
- you want JavaScript component documentation rather than CSS-centric docs

## Facets
- artifact type: library
- maturity: maintenance
- function: documentation, parser, markdown, cli
- domain: web-development, frontend, documentation, developer-tools
- platform: ruby, cli, cross-platform
- tags: style-guide, css-documentation, living-style-guide, ruby-gem, design-system

## Member repositories
- trulia/hologram (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:21.454709+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-30T02:49:55.603916+00:00, confidence not recorded.
  - readme: https://github.com/trulia/hologram (fetched 2026-08-28T04:06:21.454709+00:00, sha 56c14b795c82)
  - homepage: http://trulia.github.io/hologram (fetched 2026-08-29T10:29:40.904549+00:00, sha b57f161041c9)
- Data as of 2026-08-30T08:39:29.467469+00:00.