htmd-cli 0.3.0

The command line tool for htmd.
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

<div align="center">
  <h1>htmd-cli</h1>
  <p>The command line tool for <a href="https://github.com/letmutex/htmd">htmd</a></p>
</div>

### Features


- Minimal, A 2MB+ binary is all you need
- Batch, both file, directory and glob pattern are supported
- Fast, it takes only ~2s to convert 200 html files (~70MB in total size, see the benchmark [README](./bench/README.md))

# Usages


### Basic


```bash
# Read input from stdin

htmd

# Will write output to stdout

htmd test.html

# Explicit input option

htmd --input test.html

# Write output to test.md by shell

htmd test.html > test.md

# Write output to test.md internally

htmd test.html --output ./

# Read html files from a directory

htmd ./pages -o converted
```

### Inputs


Stdin (`-` as the filename), file, directory, and glob pattern are supported.

This default input is `stdin`, so after you type only `htmd` it will wait for input, to finish typing, press <kbd>Ctrl</kbd> + <kbd>D</kbd> (<kbd>Ctrl</kbd> + <kbd>Z</kbd> on Windows).

Example inputs:

- Stdin: `-`, `< page.html`
- File: `page.html`, `index.html`
- Directory: `pages`, `./folder`
- Glob pattern: `pages/\*\*/\*.html`, `./\*.html`

### Output


Stdout (`-` as the filename), file, and directory are supported. Defaults to stdout.

You cannot set output as stdout when you have multiple input files.

Example outputs:

- Stdout: `-`
- File: `output.md`,
- Directory: `output`, `./converted`

### With conversion options


```bash
htmd test.html --ignored-tags "head,script,style" --heading-style setex
```

### Flatten output


By default, when converting files using glob patterns such as `pages/**/*.html`, output files will follow the original folder hierarchy, to flatten output files, use `--flatten-output`.

```bash
htmd pages/**/*.html --output converted --flatten-output
```

### Load options form toml file


You can save your options to a toml file

```toml
# htmd-options.toml

[options]
ignored-tags =["head", "script", "style"]
heading-style = "setex"
```

Then load them using `--options-file`

```
htmd test.html --options-file htmd-options.toml
```

# Install


### Cargo


```bash
cargo install htmd-cli
```

### Binaries


You can download binaries from [GitHub - Releases](https://github.com/letmutex/htmd-cli/releases)

# License


```
Copyright 2024 letmutex

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```