go-grip
Render your markdown files local
- with the look of GitHub
⚡️Features
- ⚡️Written in Go
- 📄 Render markdown to HTML and view it in your browser
- 📱 Dark and white mode
- 🎨 Syntax highlighting for code
- Todo list like the one on GitHub
Tip
Support of blockquotes (note, tip, important, warning and caution) see here
🚀 Getting started
To install go-grip, simply:
go install github.com/chrishrb/go-grip@latest
Tip
You can also use nix flakes to install this plugin. More useful information here.
🔨 Usage
To render the README.md file simply execute:
go-grip README.md
# or
go-grip
The browser will automatically open on http://localhost:6419. You can disable this behaviour with the -b=false option.
You can also specify a port:
go-grip -p 80 README.md
or just open a file-tree with all available files in the current directory:
go-grip -r=false
It's also possible to activate the darkmode:
go-grip -d .
To terminate the current server simply press CTRL-C.
📝 Examples
🐛 Known TODOs / Bugs
- Tests and refactoring
- Make it possible to export the generated html
📌 Similar tools
This tool is a Go-based reimplementation of the original grip, offering the same functionality without relying on GitHub's web API.