marustdown 0.1.3

A fast, configurable terminal markdown viewer with syntax highlighting, task toggling and keyboard link following
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

# marustdown

A fast terminal markdown viewer with **syntax highlighting**, task lists you can check
off, and an outline for jumping around. See the [README](../README.md) for more.

## Code

```rust
use std::collections::HashMap;

/// Counts how often each word appears.
fn word_count(text: &str) -> HashMap<&str, usize> {
    let mut counts = HashMap::new();
    for word in text.split_whitespace() {
        *counts.entry(word).or_insert(0) += 1; // one more
    }
    counts
}
```

> [!TIP]
> Press `y` to copy a code block to the clipboard, even over SSH.

## Tasks

- [x] Render markdown in the terminal
- [ ] Check off tasks with `x`
- [ ] Jump anywhere with the outline

## Keys

| Key | Action |
|:---:|--------|
| `x` | Toggle the task under the cursor |
| `o` | Open the outline |
| `f` | Follow a link from the keyboard |

## Configuration

### Themes

Pick `dark`, `light` or `ansi`, or write your own theme file.

### Key bindings

Every key can be rebound in `~/.config/marustdown/config.toml`.