simplebookmarker 0.1.1

Add PDF bookmarks from a simple indented text file
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

# simplebookmarker

`simplebookmarker` provides the `sbm` command, which adds PDF bookmarks from an
indented plain-text table of contents.

## Installation

```console
cargo install simplebookmarker
```

## Usage

Given `book.pdf` and `book.txt`, run:

```console
sbm book
```

The result is written to `book_bm.pdf`.

Input, bookmark, and output paths can also be set explicitly:

```console
sbm --input source.pdf --bookmarks contents.txt --output result.pdf
```

Run `sbm --help` for all options.

## Bookmark format

Each valid line starts with a one-based PDF page number and a title. A hyphen
between the page number and title is optional. Indent child bookmarks with one
tab or four spaces per level.

```text
1-Introduction
    3-Background
        5-History
10 First chapter
```

Blank and malformed lines are ignored. Entries with page zero or a page number
beyond the end of the PDF are also ignored. If indentation skips a level, the
entry is attached at the deepest available level.

## License

MIT

## Release process

Run the **Bump version** workflow from GitHub Actions and choose `patch`,
`minor`, or `major`. The workflow updates `Cargo.toml` and `Cargo.lock`, runs
all checks, commits the new version to `main`, and pushes a matching `vX.Y.Z`
tag.

Create and publish a GitHub Release from that tag. The **Publish to crates.io**
workflow verifies that the tag matches the Cargo package version, runs the
tests, and publishes using the `CARGO_REGISTRY_TOKEN` secret in the `crates.io`
environment.