mdfried 0.22.0

A markdown viewer for the terminal that renders images and big headers
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

# Help

**Press `Esc` or type `:back` to exit this help document.**

## Key bindings

Key | Alt Key(s) | Description
----|------------|------------
`q` | `Ctrl-c`   | Quit and leave contents on terminal
`r` |            | Reload the file (unless piped stdin)
`j` | `↑`        | Scroll down one line
`k` | `↓`        | Scroll up one line
`d` | `Ctrl-d`   | Scroll down half page
`u` | `Ctrl-u`   | Scroll up half page
`f` | `PageDown`, `Space` | Scroll down a page
`b` | `PageUp`   | Scroll up a page
`g` |            | Go to start of file
`G` |            | Go to end of file
`<number>G` | `<number>g` | Jump to line #\<number>
`/` |            | Search text
`n` |            | Jump to next match or link
`N` |            | Jump to previous match or link
`Enter` |        | Open or follow selected link
`Esc` |          | Leave search or link modes

Entering a number before motion applies the motion that many times.

## Link Navigation

Upon pressing `n` or `N`, "link mode" is activated. 
The nearest hyperlink is highlighted.
Pressing `n` again highlights the next hyperlink, and `N` goes backwards.
Pressing `Enter` opens the hyperlink.
"Opens" means different things, depending on the current source and the link itself.

* If the link ends in `.md`, it will be opened as new document.
* If the link is relative, it will be opened with the same current base URL (if any).
* If the link does not end in `.md`, and `url_transform_command` is configured, it will be fetched, transformed, and openend as new document.

Pressing `Esc` exits "link mode".

Links that are in `#kebab-case` are interpreted as "link to headers", internal to the document, and scroll the document to the referred header.

## Search

Upon pressing `/`, "search mode input" is activated.
This is indicated by a green `/` in the status bar.

You can then type and erase the search term, highlights in the viewport will be made visible immediately.
Press enter to complete the input, then "search mode" is activated, which works just like [Link Navigation](#link-navigation).

## Commands

Command        | Description
---------------|------------
`:back`        | Go back one entry in history
`:help`        | Opens this help markdown document
`:help configuration` | Opens the configuration help
`:open <path>` | Open a file

## Command Line Interface

```bash
mdfried [OPTIONS] [SOURCE]
```

* `[SOURCE]`
  A file path, a URL, or a `github:<owner>/<repo>` source to open.
  If ommitted, tries to read from stdin, i.e. you can pipe markdown into mdfried.
* `--help`
  CLI help.
* `--version`, `-V`
  Print the version.
* `--watch`, `-w`
  Watch the file for changes and reload.
* `--deep-fry`, `-d`
  Deep fry images.
* `--setup`
  Run the font setup again, if applicable.
* `--print-config`
  Print an example configuration, and the path to the configuration file on your system.
* `--log`
  Log to stderr, useful for debugging (e.g. redirect to another tty: `mdfried --log 2>/dev/pts/7`).

## Configuration

Type `:help configuration` to open [configuration.md](./help_configuration.md).