go-grip/README.md

go-grip

Render your markdown files local
- with the look of GitHub

🚀 Getting started

To install go-grip, simply:

go install github.com/chrishrb/go-grip@latest

🔨 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

• GitHub alert block

  > [!NOTE]
  > Useful information that users should know, even when skimming content.
  

• Checkboxes (like in this todo list)
• Tests and refactoring

📌 Similar tools

This tool is, like the name already says, a reimplementation of grip in go and without using the web API of GitHub.