twars-url2md 1.1.1

A powerful CLI tool that fetches web pages and converts them to clean Markdown format using Monolith for content extraction and htmd for conversion
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

# twars-url2md

[![CI](https://github.com/twardoch/twars-url2md/workflows/CI/badge.svg)](https://github.com/twardoch/twars-url2md/actions)
[![Crates.io](https://img.shields.io/crates/v/twars-url2md)](https://crates.io/crates/twars-url2md)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A command-line tool that converts web pages to Markdown. It fetches HTML content, processes it to remove unnecessary styling, and converts it to clean Markdown format.

## Features

- Fetch HTML content from URLs with proper user agent identification
- Remove styles and unnecessary formatting
- Convert HTML to clean Markdown
- Process multiple URLs in parallel
- Smart output path handling based on URL structure
- Support for input from:
  - Command line arguments
  - Input file (one URL per line)
  - Standard input (space or newline separated)

## Installation

### From crates.io

```bash
cargo install twars-url2md
```

### From Binary Releases

Pre-built binaries are available for Linux, macOS, and Windows on the [Releases page](https://github.com/twardoch/twars-url2md/releases).

### From source

```bash
git clone https://github.com/twardoch/twars-url2md.git
cd twars-url2md
cargo install --path .
```

## Usage

```bash
# Process a single URL and print to stdout
twars-url2md https://example.com

# Process a single URL and save to file
twars-url2md https://example.com -o example.md

# Process multiple URLs and save to current directory (creates domain-based folders)
twars-url2md https://example.com https://example.org

# Process multiple URLs and save to specific directory
twars-url2md https://example.com https://example.org -o output/

# Process URLs from a file
twars-url2md -f urls.txt -o output/

# Read URLs from stdin
echo "https://example.com https://example.org" | twars-url2md --stdin

# Show verbose output
twars-url2md -v https://example.com
```

### Output Path Structure

For URLs like `scheme://username:password@host:port/path?query#fragment`:
- Username, password, query parameters, port, and fragments are ignored
- Files are organized in folders based on the host and path
- For URLs ending in `/` or with no path, `index.md` is used as the filename
- For other URLs, the last path component is used as the filename (with `.md` extension)

Example:
```
$ twars-url2md https://example.com/ https://example.org/foo/bar
Created: example.com/index.md
Created: example.org/foo/bar.md
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for a list of changes.

## License

MIT License - see [LICENSE](LICENSE) for details.

## Author

Adam Twardoch (@twardoch)