9bb188e278
Added support for rendering the `README.md` file with a markdown parser, allowing users to customize the behavior with new flags. The `-r=false` flag can be used to disable rendering of the README.md file if no file is provided. Updated the `cmd/root.go` file to include the new flags and updated the `pkg/client.go` file to reflect the changes in the client struct.
1.2 KiB
1.2 KiB
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
📌 Similar tools
This tool is, like the name already says, a reimplementation of grip in go and without using the web API of GitHub.