mdv

https://github.com/whosowsee/mdv
Admin
mdv is a fast, themeable terminal Markdown viewer and CLI tool designed for precise rendering inside...
Tokens:38,606
Snippets:263
Trust Score:6.4
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Run examples with cargo

Source: https://github.com/whosowsee/mdv/blob/main/vendor/minus/README.md

Run the provided examples in the `examples` directory using `cargo run --example <example name> --features=<required-features>`. For example, run `dyn_tokio` with `dynamic_output` and `search` features.

```bash
cargo run --example <example name> --features=<required-features>

# for example to try the `dyn_tokio` example
cargo run --example dyn_tokio --features=dynamic_output,search
```

--------------------------------

### Rust hello world

Source: https://github.com/whosowsee/mdv/blob/main/docs/examples/sample.md

Rust example printing a greeting to the console.

```rust
fn main() {
    println!("Hello from Rust!");
}
```

--------------------------------

### Install mdv from source

Source: https://github.com/whosowsee/mdv/blob/main/README.md

Builds mdv from source and places the binary into the Cargo bin directory (usually ~/.cargo/bin).

```bash
git clone https://github.com/WhoSowSee/mdv.git
cd mdv
cargo install --path .
```

--------------------------------

### Install mdv with Nix (Flake)

Source: https://github.com/whosowsee/mdv/blob/main/README.md

The Nix flake builds mdv from flake.nix and installs the mdv binary into the Nix profile. Use nix run to try it without installing, or nix profile install for a persistent install.

```bash
nix run github:WhoSowSee/mdv
nix profile install github:WhoSowSee/mdv
```

--------------------------------

### Install mdv from crates.io

Source: https://github.com/whosowsee/mdv/blob/main/README.md

Installs the latest published release of mdv from crates.io into the Cargo bin directory.

```bash
cargo install mdv
```

--------------------------------

### Diff example

Source: https://github.com/whosowsee/mdv/blob/main/docs/examples/sample.md

Diff block showing a change from debug to release output.

```diff
- println!("Debug output");
+ println!("Release output");
```

--------------------------------

### Create a user theme with extends: monokai

Source: https://github.com/whosowsee/mdv/blob/main/README.md

Example user theme file that extends the built-in monokai theme and overrides a few fields. Place it in <config_dir>/themes/ as a .yaml file to register it; the filename becomes the theme name. Demonstrates the pager_status_bar_transparent, inline_style, and syntax overrides.

```yaml
# <config_dir>/themes/warm.yaml
name: warm
description: Warm red accent layered on top of monokai.
extends: monokai
pager_status_bar_transparent: true

h1: "#ff5577"
link: "#66ccff"
background: "#1c1c1c"

inline_style:
  code:
    backticks: false
    underline: true

syntax:
  keyword: "#ff5577"
```

--------------------------------

### User preset YAML file (project-docs.yaml)

Source: https://github.com/whosowsee/mdv/blob/main/README.md

User preset file that must be placed under <config_dir>/presets/ with a .yaml or .yml extension. Accepts the same keys as docs/examples/config.yaml plus a required non-empty name field. Acts as a partial layer: omitted settings remain unchanged, while explicit values (including false, defaults, and null) override the configuration beneath it. A user preset with the same name as a built-in replaces the built-in.

```yaml
# <config_dir>/presets/project-docs.yaml
name: project-docs
theme: monokai
wrap: word
reflow: true
table_wrap: wrap
link_style: inlinetable
inline_style:
  code:
    backticks: false
```

--------------------------------

### mdv stdin and pipeline usage

Source: https://github.com/whosowsee/mdv/blob/main/README.md

Shows how to read from standard input (stdin) and work in pipelines.

```text
mdv [OPTIONS] -
cat <FILE> | mdv
```
Tokens:
Raw