mdcat-ng 0.2.1

cat for markdown: show markdown documents in terminals
Documentation 
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

# mdcat-ng 0.2

**Fancy `cat` for CommonMark — with inline images, OSC 8 links,
GFM alerts, footnotes, and a markdown-aware interactive viewer.**

## Syntax highlighting across languages

Rust:

```rust
fn render(md: &str) -> String {
    Parser::new_ext(md, markdown_options())
        .map(stylise)
        .collect()
}
```

Python[^py]:

```python
from dataclasses import dataclass

@dataclass(frozen=True)
class Heading:
    level: int
    text: str

    def anchor(self) -> str:
        return self.text.lower().replace(" ", "-")
```

TypeScript:

```typescript
type Match = { line: number; styled: [number, number] };

const firstAfter = (matches: Match[], top: number): Match | null =>
    matches.find(m => m.line > top) ?? null;
```

Bash:

```bash
for f in target/release/mdcat target/release/mdless; do
    strip "$f" && codesign --force --deep --sign - "$f"
done
```

JSON:

```json
{
  "name": "mdcat",
  "version": "3.0.0",
  "bins": ["mdcat", "mdless"],
  "features": ["sixel", "svg", "image-processing"]
}
```

SQL[^sql]:

```sql
SELECT heading.text, COUNT(ref.id) AS references
FROM heading LEFT JOIN reference ref ON ref.heading_id = heading.id
GROUP BY heading.id
HAVING references > 0
ORDER BY references DESC;
```

Go:

```go
func stripAnsi(b []byte) []byte {
    out := b[:0]
    for i := 0; i < len(b); i++ {
        if b[i] == 0x1b {
            i = skipEscape(b, i) - 1
            continue
        }
        out = append(out, b[i])
    }
    return out
}
```

## A tight feature matrix

| Capability            | 2.x | **0.2** | Notes                         |
|:----------------------|:---:|:-------:|:------------------------------|
| Inline images         |  ✓  |  **✓**  | iTerm2, Kitty, Sixel, …       |
| Interactive viewer    |     |  **✓**  | vi keys, search, bookmarks    |
| GFM alerts            |     |  **✓**  | NOTE / TIP / WARNING / …      |
| Footnotes             |     |  **✓**  | Refs + bottom-of-doc bodies   |
| Definition lists      |     |  **✓**  |                               |
| Wiki links            |     |  **✓**  | `[[Page]]`                    |
| tmux passthrough      |     |  **✓**  | Images survive multiplexers   |

## Alert blockquotes speak colour

> [!NOTE]
> mdcat tags alert blockquotes with a coloured label you can see.

> [!TIP]
> Run `mdless FILE` for the built-in interactive viewer.

> [!WARNING]
> Image protocols are stripped inside `mdless` — scrolling is safe.

## Task lists track progress

- [x] Ship the interactive viewer (`mdless`)
- [x] Land markdown extensions
- [x] Record a demo worth watching
- [ ] Sleep

## Definition lists name things

pulldown-cmark
: upstream CommonMark parser mdcat consumes.

syntect
: syntax highlighter behind every fenced code block.

resvg
: SVG rasteriser feeding pixel protocols.

## Footnotes and wiki links

Click the names: [[HomePage]] or [[Installation|installation docs]]
render as OSC 8 hyperlinks. Inline references surface in the
body[^mdless] and collect their bodies[^repo] at the bottom of the
document.

[^py]: The `dataclasses` decorator landed in 3.7; `frozen=True`
      makes instances hashable and immutable.
[^sql]: The query tallies how many footnote references point at
      each heading — useful for finding popular sections.
[^mdless]: `mdless` turns the same document into an interactive view
      with search, jumps, bookmarks, and a TOC modal.
[^repo]: Source: https://github.com/pawelb0/mdcat-ng

---

## Try it yourself

```sh
mdcat README.md
mdless --search "## Installation" README.md
```