# github/markup

Determines which markup library to use to render a content file (e.g. README) on GitHub

Repository: https://github.com/github/markup
Canonical: https://ross.abutalabs.com/products/markup
Language: Ruby
License: MIT
License Family: permissive
Topics: readme
Last push: 2026-07-29T11:01:13+00:00

## Health v2 (maintenance only)
Score: 80/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 95, release rhythm 50, longevity 100
- inputs: {"age_days": 6151, "days_push": 35, "days_rel": 121, "gap_med": null, "n_releases_24m": 1}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 6045, forks 3375 (observed 2026-08-28T04:09:34.589375+00:00)

## What it is
github-markup is a Ruby library that determines which markup library to use to convert content files like READMEs into HTML, supporting formats such as Markdown, Textile, reStructuredText, AsciiDoc, and MediaWiki. It is the first step of GitHub's rendering pipeline, delegating sanitization and syntax highlighting to downstream consumers.

## Use cases
- render readme files to html
- convert markdown and other markup formats to html in ruby
- detect markup format from file extension
- build a documentation rendering pipeline
- render rst asciidoc textile and mediawiki files
- replicate github's markup rendering locally

## When to choose
- you need to render many markup formats through a single ruby api
- you want format detection consistent with github's rendering
- you are building a documentation or content pipeline in ruby

## When to avoid
- you only need markdown rendering, where a dedicated markdown library is simpler
- you need html sanitization or syntax highlighting, which this library does not do
- you are not working in ruby

## Facets
- artifact type: library
- maturity: active
- function: parser, templating, documentation, markdown
- domain: documentation, developer-tools, web-development
- platform: ruby, jvm
- tags: markup-rendering, readme, html-conversion, github

## Member repositories
- github/markup (main) score 80

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:09:34.589375+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:48:57.085275+00:00, confidence not recorded.
  - readme: https://github.com/github/markup (fetched 2026-08-28T04:09:34.589375+00:00, sha 1d1135c359ca)
- Data as of 2026-08-30T08:39:29.467469+00:00.