mdbook-shiftinclude 0.2.0

mdbook preprocessor for file inclusion with shift
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

# mdbook-shiftinclude

A preprocessor for [mdbook](https://github.com/rust-lang/mdBook) for including portions of files,
but with the contents of the file shifted.

The `{{#shiftinclude }}` command extends the
[syntax](https://rust-lang.github.io/mdBook/format/mdbook.html#including-files) of the normal `{{#include }}` command to
include a shift indicator.  This is followed by a colon, and then the normal `include` syntax follows.

- A number, indicating the amount to shift.
  - A positive number shifts right by prepending that number of spaces to each line.
  - A negative number shifts left by removing that number of characters from the start of
    each line (regardless of whether they are spaces or not!).
- `auto`, which indicates that any block of whitespace that is common to all (non-empty) lines
  in the included text will be removed.

So for an input file `somefile.txt`:

```text
  Indent
     More Indent
  Back
```

The following outputs are possible:

- `{{#shiftinclude auto:somefile.txt}` gives
   ```text
   Indent
      More Indent
   Back
   ```
- `{{#shiftinclude 2:somefile.txt}` gives
   ```text
       Indent
          More Indent
       Back
   ```
- `{{#shiftinclude -2:somefile.txt}` gives
   ```text
   Indent
      More Indent
   Back
   ```
- `{{#shiftinclude -4:somefile.txt}` gives
   ```text
   dent
    More Indent
   ck
   ```

## Installation

To use, install the tool

```sh
cargo install mdbook-shiftinclude
```

and add it as a preprocessor in `book.toml`:

```toml
[preprocessor.shiftinclude]
```