Show HN: A Standalone/GitHub CLI Extension to Preview GitHub Flavored Markdown

https://news.ycombinator.com/rss Hits: 3
Summary

gh gfm-preview A Go program to preview GitHub Flavored Markdown (GFM) 馃摀. The gh-gfm-preview command start a local web server to serve the markdown document. gh gfm-preview renders the HTML using yuin/goldmark and some extensions and frontend tricks to have similar features and look to how GitHub renders a markdown. It may also be used as a GitHub CLI extension. This is a hard fork of yusukebe/gh-markdown-preview, that uses the GitHub Markdown API, but this means it doesn't work offline. The code of this repository tries to emulate the look of GitHub Markdown rendering as close as possible, but the original project will be even closer to the actual result if you don't need offline rendering. Highlights Works offline - You don't need an internet connection. - You don't need an internet connection. Fast - Since it doesn't rely on external services it is really fast. - Since it doesn't rely on external services it is really fast. No-dependencies - You can just run the standalone binary (or optionally via gh as an extension). - You can just run the standalone binary (or optionally via as an extension). Zero-configuration - You don't have to set the GitHub access token. - You don't have to set the GitHub access token. Live reloading - You don't need reload the browser. - You don't need reload the browser. Auto open browser - Your browser will be opened automatically. - Your browser will be opened automatically. Auto find port - You don't need find an available port if default is used. - You don't need find an available port if default is used. Graceful degradation - Basic functionality works even without JavaScript. Supported GFM features Installation You need to have Go installed. Standalone go run github.com/thiagokokada/gh-gfm-preview Nix Assuming that you have Flakes enabled: nix run github:thiagokokada/gh-gfm-preview GitHub Extension gh extension install thiagokokada/gh-gfm-preview Upgrade: gh extension upgrade markdown-preview Usage The usage: gh gfm-preview README....

First seen: 2025-04-20 17:25

Last seen: 2025-04-20 19:26