# Open XML DOCX

> Guide and examples for using OpenXML Docx features in the open_xml package.

- Skill: `rodydavis/open-xml-docx` (Agent Skill, multi-file: 9 files)
- Install (CLI): `npx skillmds@latest add rodydavis/open-xml-docx`
- Raw SKILL.md: https://api.skillmd.com/api/skills/rodydavis/open-xml-docx/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: rodydavis (https://skillmd.com/u/rodydavis)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/rodydavis/open-xml-docx

---


# OpenXML Word Documents (.docx)

The `open_xml` package allows for generating, editing, and parsing `.docx` documents. 

## Creating a Document

To create a new Word Document:

```dart
import 'package:open_xml/open_xml.dart';
import 'package:file/local.dart';

Future<void> main() async {
  const fs = LocalFileSystem();
  final doc = await WordDocument.create(fs);
  
  // Save the document
  await doc.save(fs.file('example.docx'));
}
```

## Adding Paragraphs and Text Runs

A `WordDocument` contains a sequence of elements, most commonly `Paragraph`s. A `Paragraph` contains a sequence of `Run`s.

```dart
  // Add a simple paragraph
  doc.addParagraph(
    Paragraph()
      ..addRun(Run(text: 'Hello, '))
      ..addRun(Run(
        text: 'World!', 
        bold: true, 
        color: 'FF0000', 
        fontSize: 24,
      )),
  );
```

### Run Formatting Options
- `bold`: Boolean (true/false)
- `italic`: Boolean (true/false)
- `underline`: Boolean (true/false)
- `color`: Hex color string (e.g. '00FF00')
- `fontSize`: Integer representing half-points.
- `fontFamily`: String representing font face.

## Hyperlinks

Hyperlinks can be added to paragraphs easily:

```dart
doc.addParagraph(
  Paragraph()
    ..addHyperlink(
      'Visit Google',
      'https://google.com',
    ),
);
```

## Comments

You can insert comments on a specific text range:

```dart
doc.addParagraph(
  Paragraph()
    ..addComment(
      author: 'Author Name',
      text: 'This is a comment on the text',
      initials: 'AN',
      run: Run(text: 'commented text'),
    ),
);
```

## Markdown Conversion

You can generate a `.docx` document directly from Markdown, or extract Markdown from an existing `.docx`.

### Markdown to Docx
```dart
final markdown = '''
# Heading 1
This is a paragraph with **bold** and *italic* text.
''';

await doc.addMarkdown(markdown);
```

### Docx to Markdown
```dart
final existingDoc = await WordDocument.open(fs.file('my_doc.docx'));
final markdownText = existingDoc.toMarkdown();
print(markdownText);
```

## Parsing Docx Files

You can extract text nodes or navigate through paragraphs in existing documents:

```dart
final existingDoc = await WordDocument.open(fs.file('my_doc.docx'));

// Iterate over text runs
for (final text in existingDoc.parseText()) {
  print(text);
}
```


## Examples

- [docx_to_markdown_example](examples/docx_to_markdown_example.md)
- [docx_markdown_example](examples/docx_markdown_example.md)
- [docx_images_example](examples/docx_images_example.md)
- [docx_comments_example](examples/docx_comments_example.md)
- [docx_example](examples/docx_example.md)
- [docx_hyperlinks_example](examples/docx_hyperlinks_example.md)
- [docx_parser_example](examples/docx_parser_example.md)
- [docx_high_level_example](examples/docx_high_level_example.md)