see-cat 0.9.2

A cute cat(1)
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

# see: simple Markdown and Code renderer

## Usage

```bash
see [OPTIONS] [FILE]
```

If FILE is not provided, see reads from standard input.

## Options

|                          |                                                     |
| ------------------------ | --------------------------------------------------- |
| `--debug`                | Enable debug mode for verbose output                |
| `--help`                 | Display this help information                       |
| `--version`              | Display version information                         |
| `--generate-config`      | Generate a default configuration file               |
| `--max-image-width`      | Set maximum width for rendered images               |
| `--max-image-height`     | Set maximum height for rendered images              |
| `--page`                 | Enable or disable built-in page mode for text output |
| `--watch`                | Keep the preview open and auto-reload when the file changes |
| `--watch-interval-ms`    | Polling interval for `--watch` in milliseconds      |
| `--render-images`        | Enable or disable image rendering                   |
| `--render-links`         | Enable or disable clickable links                   |
| `--render-table-borders` | Enable or disable table borders in rendered output  |
| `--show-line-numbers`    | Show or hide line numbers when rendering code files |
| `--show-filename`        | Show or hide the filename before rendering content  |
| `--config <file>`        | Specify a custom configuration file                 |
| `--use-colors`           | Control color output                                |
| `--convert-html`         | Enable or disable HTML to Markdown conversion       |

## Examples

Render a Markdown file:

```bash
see path/to/your/markdown_file.md
```

Render a code file without line numbers:

```bash
see --show-line-numbers=false path/to/your/code_file.py
```

Render from standard input:

```bash
echo "# Hello, world" | see
```

Generate a default configuration file:

```bash
see --generate-config
```

Use a custom configuration file:

```bash
see --config /path/to/custom/config.toml path/to/your/markdown_file.md
```

Render with maximum image dimensions:

```bash
see --max-image-width=60 --max-image-height=20 path/to/your/markdown_file.md
```

Enable page mode:

```bash
see --page=true path/to/your/markdown_file.md
```

Enable live preview while editing in another tmux pane:

```bash
see --watch path/to/your/markdown_file.md
```

Page mode keys:

```text
q quit
r reload
j / k scroll
PgUp / PgDn page
g / G top or bottom
```

Disable image rendering:

```bash
see --render-images=false path/to/your/markdown_file.md
```

Enable table borders:

```bash
see --render-table-borders=true path/to/your/markdown_file.md
```

Disable color output when piping to another command:

```bash
see --use-colors=false path/to/your/markdown_file.rs | less
```

Render content without showing the filename:

```bash
see --show-filename=false path/to/your/markdown_file.md
```

Convert HTML to Markdown:

```bash
see --convert-html=true path/to/your/file_with_html.md
```

## Tradeoff

`see` intentionally bundles broad built-in syntax highlighting support. This keeps usage simple and avoids extra language installation steps, but it also makes the binary larger than a minimal language set would.