Uniword is a comprehensive Ruby library for reading and writing Microsoft Word documents in both DOCX (Word 2007+) and MHTML (Word 2003+) formats, with 100% OOXML specification coverage and perfect round-trip fidelity.

1. Quick Navigation

1.1. By Your Role

Ruby Developer

Start with Quick Start then Ruby API to build documents programmatically.

Technical Writer

Start with Themes and StyleSets to style documents, then Theme Catalog for the full list.

QA Engineer

Start with Three-Layer Pipeline for DOCX validation, then CLI: verify command.

DevOps

Start with CLI for command-line conversion and Format Conversion for batch processing.

Contributor

Start with Contributing then Adding OOXML Elements.

1.2. By Task

Create a document
Open and modify an existing DOCX
Apply themes and styles
Validate DOCX files
Convert formats

2. Learning Path

2.1. Level 1: Get Started (5 minutes)

  1. Install Uniword

  2. Try basic examples

  3. Understand core concepts

2.2. Level 2: Learn Interfaces (15 minutes)

Choose your interface:

  • Ruby API — Build documents programmatically

  • CLI — Command-line usage

2.3. Level 3: Follow Guides (30 minutes)

  1. Text Formatting

  2. Tables

  3. Themes

  4. StyleSets

2.4. Level 4: Understand the Design (1 hour)

  1. Architecture overview

  2. Schema-driven generation

  3. Prevention Layer

2.5. Level 5: Master Features (As needed)

  1. 29 bundled themes

  2. 12 bundled stylesets

  3. 23 color schemes

  4. Custom validation rules

3. Getting Help

Found a bug?

Report an issue on GitHub

Have a question?

Search this documentation or check the CLI reference

Want to contribute?

See Contributing to Uniword