40fa2a7b86
This commit updates the go-grip project to use golangci-lint for code quality checks, improves the build process by adding a check for formatting errors, and enhances the release workflow by using the new golangci-lint action. The changes address issues with code quality and maintainability, ensuring that the project adheres to best practices. The improved build process reduces the risk of formatting errors, while the updated release workflow ensures that the project is properly formatted before being released.
1.1 KiB
1.1 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 a markdown file simply execute:
go-grip README.md
The browser will automatically be opened 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
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.