https://github.com/sixlive/gogrip
An easy way to preview rendered markdown files locally
https://github.com/sixlive/gogrip
Last synced: 9 months ago
JSON representation
An easy way to preview rendered markdown files locally
- Host: GitHub
- URL: https://github.com/sixlive/gogrip
- Owner: sixlive
- Created: 2024-10-28T13:06:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-07T13:50:02.000Z (about 1 year ago)
- Last Synced: 2025-03-28T16:44:37.052Z (10 months ago)
- Language: Go
- Homepage:
- Size: 5.66 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GoGrip - GitHub Readme Preview
A minimal command-line tool that renders local markdown files using GitHub's API.
## Installation
You can install via go using the following command:
```shell
go install github.com/sixlive/gogrip@latest
```
You can also install by snagging a pre-built binary from the [releases](https://github.com/sixlive/gogrip/releases/latest) page.
## Usage
Basic usage with default README.md:
```shell
gogrip
```
Specify a different file:
```shell
gogrip -f CONTRIBUTING.md
```
Open in browser automatically:
```shell
gogrip -b
```
Custom host and port:
```shell
gogrip -host 0.0.0.0 -port 8080
```
```shell
With GitHub authentication (for higher rate limits):
gogrip -token YOUR_GITHUB_TOKEN
```
## Options
```
Usage of gogrip:
-host string
Host to listen on (default "localhost")
-port int
Port to listen on (default 6419)
-f string
File to render (default "README.md")
-token string
GitHub personal access token
-b
Open browser automatically
```
## Acknowledgments
This project is inspired by [Grip](https://github.com/joeyespo/grip), the Python-based GitHub Readme Instant Preview tool.
## License
MIT