R RusDoxOne spec. Two trustworthy documents.

Start here

Documentation

Choose the shortest path from installation to a trustworthy DOCX and PDF workflow.

View Markdown source

RusDox lets you write documents as YAML and generate real .docx and .pdf files with a Rust engine underneath.

If you are new, read these pages in order:

  1. Getting Started
  2. YAML Guide
  3. Configuration
  4. CLI Guide
  5. Gallery
  6. Rust API
  7. Compatibility Matrix
  8. Dated Viewer Scorecard
  9. International and Accessible Output
  10. Tagged PDF, PDF/UA, and PDF/A Research
  11. Input Safety and Limits
  12. Parity Verification
  13. Reproducible Performance
  14. Word-native Templates
  15. Spec Versioning and Authoring Tools
  16. Stability, Versioning, and Support
  17. Release Checklist
  18. v1.0.0 Release Evidence
  19. Troubleshooting

Pick Your Path

If you want the simplest path:

  • Start with Getting Started
  • Use YAML files
  • Run rusdox validate mydoc.yaml before big renders or CI
  • Use rusdox config wizard --level basic

If you want more control:

  • Read YAML Guide
  • Read Configuration
  • Use variables, includes, repeaters, bounded conditions, and deterministic filters when static YAML starts getting repetitive
  • Generate the versioned schema or install the local VS Code authoring extension
  • Use local ./rusdox.toml overrides per project

If you are a developer and want full power:

  • Read Rust API
  • Use DocumentSpec from Rust for programmatic YAML-style documents
  • Drop down to Document, Paragraph, Run, and Table when needed

What The Docs Cover

  • how to install RusDox
  • how to create your first YAML document
  • how output folders work
  • how DOCX and PDF generation works
  • how to style documents with config and named styles
  • how to reuse specs with variables, includes, repeaters, conditions, and filters
  • how to generate the schema, migrate legacy specs, and get source-located editor diagnostics
  • which v1 contracts follow SemVer, the MSRV, deprecation window, and supported release policy
  • how to set document metadata and custom properties
  • how font fallback, embedding permissions, alt text, and language metadata are enforced
  • why current PDF output makes no tagged-PDF, PDF/UA, or PDF/A claim
  • how to render one file or a whole folder
  • how to validate, watch, and benchmark from the CLI
  • how to reproduce performance results and interpret regression evidence
  • how to turn designer-authored Word files into verified JSON-driven outputs
  • how to use the Rust layer for advanced cases
  • exactly which DOCX/PDF features are supported today
  • how to diagnose installation, font, asset, table, and viewer problems

Core Idea

RusDox works best when you keep these roles separate:

  • content lives in YAML
  • styling lives in config
  • speed lives in Rust

Documentation map

Find the exact layer you need.

Overview

OverviewProject overview

The product promise, benchmark, examples, installation paths, and current support boundary.

Authoring

GuideGetting started

Install RusDox and generate the first editable DOCX and native PDF in minutes.

GuideYAML guide

Learn document blocks, styles, composition, tables, visuals, and reusable authoring patterns.

GuideSpec versioning

Generate schemas, migrate legacy specs, use deterministic expressions, and configure editor feedback.

GuideConfiguration

Control typography, spacing, color, tables, output paths, and PDF rendering.

GuideWord-native templates

Turn designer-authored DOCX files and JSON data into editable Word, native PDF, and parity evidence.

Trust & operations

ContractStability and support

Understand v1 SemVer guarantees, deprecation windows, MSRV, output stability, and supported releases.

OperationsRelease checklist

Require contract, parity, compatibility, performance, supply-chain, and publication evidence for every release.

Releasev1.0.0 release evidence

Inspect the exact contract, test, parity, security, reproducibility, registry, and publication gates for RusDox v1.0.0.

DecisionBrowser rendering feasibility

Understand what the browser playground proves, why edited files still use the CLI, and the gates for a full WASM renderer.

IntegrationGitHub Action

Validate specs, annotate pull-request lines, render outputs, and retain private parity evidence inside GitHub Actions.

TrustCompatibility matrix

See exactly what works in DOCX, PDF, both outputs, or not yet.

TrustViewer compatibility scorecard

Review dated, hash-pinned evidence from real document viewers without universal claims.

TrustInternational and accessible output

Review script graduation gates, font embedding, alternative text, language metadata, and accessibility parity.

DecisionPDF conformance research

Understand the tagged PDF, PDF/UA, PDF/A, validator, and human-review gates before any conformance claim.

SecurityInput safety and limits

Understand resource ceilings, fuzz targets, and atomic output recovery for untrusted inputs.

Securityv1 security review

Review the ZIP, XML, visual, template, protocol, batch, and release threat model with residual risks.

OperationsProduction and batch rendering

Run bounded concurrent jobs with service-owned limits, ordered results, and cooperative cancellation.

TrustParity verification

Generate machine-readable semantic checks and deterministic rendered-page diffs for DOCX and PDF.

TrustReproducible performance

Reproduce isolated benchmark tiers, inspect raw evidence, and understand material regression thresholds.

OperationsTroubleshooting

Diagnose installers, paths, fonts, viewer differences, large files, and CI failures.

Examples

GuideCurated template registry

Discover, verify, install, update, and contribute signed Word templates without expanding the core crate.

ExamplesTemplate gallery

Browse real YAML inputs and generated DOCX/PDF output previews.

ExamplesExamples guide

Understand every bundled document fixture and how to render it.

Reference

IntegrationIntegration protocol

Embed the renderer or call one stable local JSON protocol from Node, Python, Go, CI, and loopback HTTP.

ReferenceCLI reference

Render, validate, watch, benchmark, initialize, and configure documents.

ReferenceRust API

Choose between DocumentSpec, Studio, and the low-level typed document model.

Project

ProjectRoadmap

Follow the path to verified parity, Word templates, integrations, and v1.

ProjectChangelog

Review user-facing additions, changes, fixes, and migrations.

Community

CommunityContributing

Set up the repository and submit a focused contribution.

CommunityArchitecture

Follow one typed document model from authoring and validation through DOCX, PDF, parity, and every adapter.

CommunityGovernance

Review the decision model, path to committer, release authority, and conflict policy.

CommunityContributors

Meet the people credited by the actual Git history and learn how new contributions are recognized.

CommunitySupport

Find the right place for questions, reproducible bugs, and security reports.

CommunitySecurity policy

Understand supported releases, reporting scope, and private disclosure.

CommunityCode of conduct

Behavior and enforcement standards for a healthy community.