This project is very early and is in active development!
kurz allows you to view markdown documents on the command-line in a feature-rich UI.
- Expand/collapse content sections.
- Copy content text to your clipboard.
- Load remote or local files.
- Discover README of remote Git repositories on GitHub, BitBucket and GitLab.
- TODO Cache remote files for offline access.
- TODO Syntax highlighting for code snippets.
$ go get github.com/KyleBanks/kurz/cmd/kurz
There are three primary ways to use kurz:
- Load a local markdown file:
$ kurz ./path/to/file.md
- Or use a remote URL:
$ kurz https://example.com/markdown-file.md
- Provide a Git repository to view its README:
$ kurz github.com/KyleBanks/kurz