jumpcut 1.0.0

JumpCut is a library and CLI for converting Fountain-formatted text files into FDX, HTML, JSON, text, and PDF formats.
Documentation 
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

# Embedded HTML Fonts

JumpCut can optionally embed the four Courier Prime TTF files directly into generated HTML as `data:` URLs inside CSS `@font-face` rules.

This is useful when you want a single portable HTML file that does not depend on local font installation.

## Native CLI and Rust Library

The embedded-font path is off by default.

CLI:

```sh
jumpcut --format html --embed-courier-prime input.fountain output.html
```

To embed a custom four-face TrueType family instead of the bundled Courier Prime files, use the `--font-dir` option alongside `--embed-courier-prime`:

```sh
jumpcut --format html --embed-courier-prime --font-dir ./my-fonts input.fountain output.html
```

The directory must contain `regular.ttf`, `bold.ttf`, `italic.ttf`, and `bold-italic.ttf`, or the Courier Prime-style aliases documented in the README. The custom faces are mapped to the CSS family name `Courier Prime`, so the existing screenplay stylesheet uses them without other changes.

Rust:

```rust
let mut screenplay = jumpcut::parse(&content);
let html = screenplay.to_html_with_options(jumpcut::html_output::HtmlRenderOptions {
    head: true,
    exact_wraps: false,
    paginated: true,
    embed_courier_prime: true,
    embedded_courier_prime_css: None,
});
```

When `embed_courier_prime` is `false`, JumpCut keeps the normal local-font lookup plus Courier fallbacks.

## WASM

For wasm, JumpCut does **not** compile the Courier Prime font bytes into the `.wasm` binary.

Instead, the wasm wrapper exposes a runtime-supplied path:

- `parse_to_html_string(text, include_head)`
- `parse_to_html_string_with_options(text, include_head, exact_wraps, paginated)`
- `parse_to_html_string_with_embedded_courier_prime(text, include_head, exact_wraps, paginated, regular_ttf_base64, italic_ttf_base64, bold_ttf_base64, bold_italic_ttf_base64)`

That lets the app fetch or bundle the font files separately and only pay the cost when the user actually requests embedded-font export.

Example:

```js
import init, {
  parse_to_html_string_with_embedded_courier_prime,
} from "./jumpcut_wasm.js";

await init();

const [regular, italic, bold, boldItalic] = await Promise.all([
  fetch("/fonts/CourierPrime-Regular.ttf").then(r => r.arrayBuffer()),
  fetch("/fonts/CourierPrime-Italic.ttf").then(r => r.arrayBuffer()),
  fetch("/fonts/CourierPrime-Bold.ttf").then(r => r.arrayBuffer()),
  fetch("/fonts/CourierPrime-BoldItalic.ttf").then(r => r.arrayBuffer()),
]);

const toBase64 = buf =>
  btoa(String.fromCharCode(...new Uint8Array(buf)));

const html = parse_to_html_string_with_embedded_courier_prime(
  fountainText,
  true,
  false,
  true,
  toBase64(regular),
  toBase64(italic),
  toBase64(bold),
  toBase64(boldItalic),
);
```

## Size Notes

Embedding Courier Prime materially increases HTML size because the font data is stored inline.