leaf-markdown-viewer 1.26.2

Terminal Markdown previewer with a GUI-like experience
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

# Contributing

Thank you for your interest in contributing to `leaf`.

## Getting Started

1. Fork the repository.
2. Clone your fork:

```bash
git clone https://github.com/<your-username>/leaf.git
cd leaf
```

3. Install Rust if needed:

```bash
rustup show
```

4. Build the project:

```bash
cargo build
```

5. Run the application:

```bash
cargo run -- README.md
```

## Development Workflow

Before submitting a PR, run the full validation sequence:

```bash
cargo test
cargo clippy --all-targets --all-features -- -D warnings
cargo build --release
```

## Pull Requests

1. Create a feature branch from `main`.
2. Make focused changes.
3. Keep documentation in sync when behavior changes.
4. Ensure all checks pass.
5. Open a PR with a clear description of:
   - what changed;
   - why it changed;
   - how it was tested.

## Commit Messages

- Use clear, direct messages.
- Keep the first line short.
- Prefer the existing prefixes used in the repository when they fit.

Examples:

- `feat: custom themes`
- `chore: refactor main.rs`
- `fix: file picker alignment`
- `docs: update README.md`

## Code Style

- Follow the existing Rust style in the repository.
- Prefer small, targeted refactors over broad rewrites.
- Preserve the current terminal UX unless the change explicitly improves it.
- Keep ASCII by default unless the file already uses Unicode intentionally.

## Testing Notes

- Add regression tests when fixing rendering or parsing bugs.
- Prefer narrow, behavior-focused tests over snapshot-heavy tests.
- If a change affects terminal layout, verify both tests and manual rendering.

## Architecture

See:

- [ARCHITECTURE.md](./ARCHITECTURE.md)

## Releases

Release automation lives in:

- [.github/workflows/release-cut.yml](./.github/workflows/release-cut.yml)
- [.github/workflows/release-build.yml](./.github/workflows/release-build.yml)
- [scripts/release-cut.sh](./scripts/release-cut.sh)

Installers live in:

- [scripts/install.sh](./scripts/install.sh)
- [scripts/install.ps1](./scripts/install.ps1)

## Questions

Open an issue or discussion in the repository:

- https://github.com/RivoLink/leaf/issues
- https://github.com/RivoLink/leaf/discussions