grip - Man Page
manual page for Grip 4.6.2
Examples (TL;DR)
- Start the server and serve the rendered
READMEfile of a current directory:grip - Start the server and serve a specific Markdown file:
grip path/to/file.md - Start the server and open the
READMEfile of the current directory in the browser:grip [-b|--browser] - Start the server in the specified port and serve the rendered
READMEfile of the current directory:grip port
Description
Usage
grip [options] [<path>] [<address>] grip -V | --version grip -h | --help
Where
<path> is a file to render or a directory containing README.md (- for stdin) <address> is what to listen on, of the form <host>[:<port>], or just <port>
Options
- --user-content
Render as user-content like comments or issues.
- --context=<repo>
The repository context, only taken into account when using --user-content.
- --user=<username> A GitHub username for API authentication. If used
without the --pass option, an upcoming password input will be necessary.
--pass=<password> A GitHub password or auth token for API auth.
- --wide
Renders wide, i.e. when the side nav is collapsed. This only takes effect when --user-content is used.
- --clear
Clears the cached styles and assets and exits.
- --export
Exports to <path>.html or README.md instead of serving, optionally using [<address>] as the out file (- for stdout).
- --no-inline
Link to styles instead inlining when using --export.
- -b --browser
Open a tab in the browser after the server starts.
- --api-url=<url>
Specify a different base URL for the github API, for example that of a Github Enterprise instance. Default is the public API: https://api.github.com
- --title=<title>
Manually sets the page's title. The default is the filename.
- --norefresh
Do not automatically refresh the Readme content when the file changes.
- --quiet
Do not print to the terminal.