Quickly view GitHub markdown gists as simple blog-style pages1.
- Go to any GitHub gist with at least one markdown file
- Change the domain in your browser from
gist.github.comtogistdoc.com2 - Hit enter
- 🎉
When you visit a gist's path on gistdoc.com the markdown content from the gist is retrieved from the GitHub API and rendered.
Gist ids are uniquely identifable, so you can omit the username from the path while using Gistdoc. For example, these two URLs will render the same document:
- https://gistdoc.com/jkulton/fcc75f45043ef5f953aa2354b05cd753
- https://gistdoc.com/fcc75f45043ef5f953aa2354b05cd753
- Viewing rendered markdown in a clean, blog-like format
- Quickly creating and sharing a post
- Presenting content in a meeting
- A lightweight blog
Yes! Secret gists aren't private, anyone with the link can view a secret gist.3
Make sure your gist includes a file ending in either .md or .markdown
Gistdoc uses your browser to retrieve gist content from the GitHub API. GitHub's endpoint for getting gists has a limit of 60 requests per hour for unauthenticated clients. Unless viewing many docs in a short period of time it's unlikely you'll exceed this limit. Gistdoc also does some client-side caching with Next.js, which helps in this respect. You can check your usage at the GitHub API rate limit route.
(This project is in no way affiliated with GitHub)
Footnotes
-
Shortcut: on a gist double-click "github" in the url, backspace twice, then type "doc" and press Enter ↩