rusdox 0.1.0

Generate DOCX and PDF from YAML at Rust speed.
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

# Getting Started

This is the fastest way to go from nothing to a generated `.docx` and `.pdf`.

## 1. Install RusDox

macOS and Linux:

```bash
curl -fsSL https://raw.githubusercontent.com/OthmaneBlial/rusdox/main/scripts/install.sh | sh
```

Windows PowerShell:

```powershell
irm https://raw.githubusercontent.com/OthmaneBlial/rusdox/main/scripts/install.ps1 | iex
```

The installer adds the `rusdox` binary and creates `~/rusdox/config.toml` if it does not exist yet.

It does not clone the full GitHub repository.

## 2. Create a document file

```bash
mkdir my-rusdox-docs
cd my-rusdox-docs
rusdox init-doc mydoc.yaml
```

That creates a starter YAML document.

## 3. Edit the YAML

Example:

```yaml
output_name: client-brief
blocks:
  - type: title
    text: Client Brief
  - type: subtitle
    text: Q2 rollout
  - type: section
    text: Summary
  - type: body
    text: Launch is approved pending final security FAQ wording.
  - type: bullets
    items:
      - Pricing is approved.
      - Support macros are in review.
      - Commercial release is planned for April 7.
```

Think of `blocks:` as the document itself, top to bottom.

## 4. Render the files

```bash
rusdox mydoc.yaml
```

By default you get:

- `generated/client-brief.docx`
- `rendered/client-brief.pdf`

If your YAML does not set `output_name`, RusDox uses the file name.

## 5. Change the style

The easiest way is the config wizard:

```bash
rusdox config wizard --level basic
```

For more control:

```bash
rusdox config wizard --level advanced
```

If you want settings only for the current project:

```bash
rusdox config wizard --path ./rusdox.toml --level basic
```

## 6. Render a whole folder

If a folder contains YAML specs, RusDox can render all of them:

```bash
rusdox examples
```

## 7. Validate before you render in CI

```bash
rusdox validate mydoc.yaml
```

That catches semantic issues such as invalid colors, table shape mismatches, missing assets, or unknown named styles before output is written.

## 8. Watch while you edit

```bash
rusdox watch mydoc.yaml
```

RusDox rebuilds when the spec or active config changes.

## 9. Measure the pipeline

```bash
rusdox bench mydoc.yaml --iterations 5 --warmup 1
```

This reports parse, validation, compose, DOCX, PDF, and total timings from the CLI.

## What Happens Behind The Scenes

When you run `rusdox mydoc.yaml`, RusDox:

1. Reads the YAML document spec
2. Applies your config
3. Builds a DOCX document in pure Rust
4. Writes a PDF preview in pure Rust

No Microsoft Word is required.

No LibreOffice is required.

## Next Pages

- [YAML Guide](yaml-guide.md)
- [Configuration](configuration.md)
- [CLI Guide](cli.md)
- [Gallery](gallery.md)