rstacruz/flatdoc

Health v2 · maintenance only

Flags: no_releases no_license

Adoption not part of the score

2656 stars · 256 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

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

library · maturity maintenance

documentation markdown parser static-site-generator documentation web-development developer-tools browser client-side github-pages readme-rendering no-build-process javascript nodejs

Member repositories

For agents

markdown · JSON · MCP: product_card(name="rstacruz/flatdoc")