text-minimap icon indicating copy to clipboard operation
text-minimap copied to clipboard

Generate text minimap/preview using Braille Patterns

Travis CI Build Status text-minimap on crates.io text-minimap documentation on docs.rs

text-minimap - Generate text minimap/preview using Braille Patterns

Library and command-line utility to efficiently generate minimap/preview of a given text.

text-minimap example

Status

  • [x] Efficient io and streaming
  • [x] Multiple scaling settings
  • [ ] Tab (\t) width support
  • [ ] Soft-wrapping on text-width support
  • [ ] C API

Alternatives

  • wfxr/code-minimap - seems also written in Rust and with more effort put into it, so you probably should prefer it over this project; probably - I had no time to check the details myself;

Installing

If you don't have rust compiler and cargo installed follow instructions on https://www.rustup.rs/ .

Afterwards:

cargo install text-minimap

Using

Check text-minimap --help output.

Verification Recommendation

To help with the maintaince, the ownership of this crate is potentially shared between multiple developers. It is recommend to always use cargo-crev to verify trustworthiness of each of your dependencies, including this one.