grip

GitHub-flavored Markdown preview server

TLDR

Preview README in current directory

$ grip

Preview and open in browser

$ grip -b

Preview specific file

$ grip [README.md]

Preview on specific port

$ grip [file.md] [8080]

Export to HTML file

$ grip --export [file.md]

Export to a specific HTML file

$ grip [README.md] --export [output.html]

Preview from stdin

$ cat [file.md] | grip -

SYNOPSIS

grip [options] [path] [address]

grip (GitHub Readme Instant Preview) is a command-line server that renders GitHub-flavored Markdown using GitHub's API. It displays how your README will appear on GitHub with accurate styling, and changes to files are reflected instantly without page refresh.Use --offline to avoid API rate limits for basic rendering.

PARAMETERS

-b, --browser

Open in browser after starting.

--export

Export to HTML file instead of serving.

--offline

Render without GitHub API.

--norefresh

Disable auto-refresh on file changes.

--quiet

Suppress terminal output.

--user user

GitHub username for API auth.

--pass pass

GitHub password or personal access token.

--wide

Render wide page layout.

--user-content

Render as user-generated content (like comments or issues).

--context repo

Repository context for relative URL linking (e.g., user/repo).

--title title

Custom page title for the rendered output.

--no-inline

Do not inline CSS styles in exported HTML.

--api-url url

Use a custom GitHub API URL (for GitHub Enterprise).

CAVEATS

Without authentication, GitHub API rate limits may apply. Use --user and --pass with a personal access token for higher limits.