# rstacruz/flatdoc

Build sites fast from Markdown

Repository: https://github.com/rstacruz/flatdoc
Canonical: https://ross.abutalabs.com/products/flatdoc
Homepage: http://ricostacruz.com/flatdoc
Language: CSS
License Family: other
Last push: 2023-05-31T11:27:01+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 4847, "days_push": 1190, "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 2656, forks 256 (observed 2026-08-28T04:07:07.315173+00:00)

## What it is
Flatdoc is a small JavaScript library that fetches Markdown files (including GitHub Readme files via the GitHub API) and renders them as full documentation pages entirely client-side. It requires no server-side components or build process, making it deployable to GitHub Pages with a single HTML file.

## Use cases
- turn a GitHub readme into a documentation site
- build project docs from markdown without a build step
- host documentation on GitHub Pages
- render markdown files client-side in the browser
- create a quick docs page for an open source project
- display a changelog or other markdown file as a styled page

## When to choose
- you want documentation with zero build process or server
- your docs already live in a GitHub Readme or markdown files
- you want a lightweight, responsive docs theme out of the box
- you need something deployable to GitHub Pages in minutes

## When to avoid
- you need server-side rendering or SEO-critical static HTML output
- you need advanced docs features like search, versioning, or multi-page navigation
- you want a modern maintained toolchain with active development
- your markdown must be processed at build time with plugins

## Facets
- artifact type: library
- maturity: maintenance
- function: documentation, markdown, parser, static-site-generator
- domain: documentation, web-development, developer-tools
- platform: browser
- tags: client-side, github-pages, readme-rendering, no-build-process, javascript, nodejs

## Member repositories
- rstacruz/flatdoc (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:07:07.315173+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:18:29.350875+00:00, confidence not recorded.
  - readme: https://github.com/rstacruz/flatdoc (fetched 2026-08-28T04:07:07.315173+00:00, sha 5d708884acb9)
  - homepage: http://ricostacruz.com/flatdoc (fetched 2026-08-29T10:01:19.679136+00:00, sha 5e4a3d433dc2)
- Data as of 2026-08-30T08:39:29.467469+00:00.