stig

Paste any GitHub markdown file or gist URL — get back a clean, scientific-paper-style rendering.

How it works

Take any of the URLs below, replace the host with stig.sh, and you get the rendered version. The path stays exactly the same.

github.com/foo/bar/blob/main/README.md
↓
stig.sh/foo/bar/blob/main/README.md

raw.githubusercontent.com/foo/bar/main/x.md
↓
stig.sh/foo/bar/main/x.md

gist.github.com/alice/abc123…def
↓
stig.sh/alice/abc123…def

Try one

Configuration

Drop a stig.json at the root of your repo (alongside README.md) to customize how stig renders your docs. All fields are optional and the file is fetched fresh on every render, with no rebuild step.

Field	Type	Default	Effect
`title`	`string`	first H1	Override the page / OG title
`description`	`string`	first ~200 chars	Override the OG / meta description
`sidebar`	`{text, path}[]`		Custom left-margin nav (paths are repo-relative)

Example:

{
  "title": "My Project",
  "description": "A short tagline for OG cards.",
  "sidebar": [
    { "text": "Introduction", "path": "README.md" },
    { "text": "Setup",        "path": "docs/setup.md" },
    { "text": "API",          "path": "docs/api.md" }
  ]
}

Different branches / tags can have different config. stig fetches stig.json at the same ref as the document being rendered. Gists are self-describing (their file list becomes the sidebar automatically), so config there is ignored.