4 releases
0.2.3 | Aug 30, 2023 |
---|---|
0.2.2 | Jun 9, 2022 |
0.2.1 | Nov 7, 2021 |
0.2.0 | Jan 16, 2019 |
#147 in Visualization
26KB
273 lines
grup - offline markdown previewer
What is grup?
grup
is an offline markdown previewer inspired by the impeccable grip - minus sending your local files to github for formatting - therefore a little easier to stomach for privacy inclined people (like me).
Installing
With Rust 1.70 or higher installed run:
cargo install grup
Usage
Get preview for an .md file e.g. README.md:
grup README.md
This will open a local webserver (by default at 127.0.0.1:8000
) and display the rendered markdown.
Refreshing the page will also cause the document to be updated.
When you're done stop grup by pressing Ctrl+C
.
Contributors
Thanks to @NickeZ
Known Issues
"No such remote or remote group: " when running grup
When trying to run grup in zsh
, the grup command will be shadowed by an alias defined by the zsh git
plugin.
This can be prevented by adding
unalias grup
to your .zshrc
which removes the alias.
Alternatively: Add an alias pointing to the install location (e.g. alias grupp="~/.cargo/bin/grup"
)
Style
By default the html output is styled using Github Markdown CSS by Sindre Sorhus.
Dependencies
~13–25MB
~361K SLoC