wordZero

English | 中文

Project Introduction

WordZero is a Golang-based Word document manipulation library that provides basic document creation and modification operations. This library follows the latest Office Open XML (OOXML) specifications and focuses on supporting modern Word document format (.docx).

Core Features

• Complete Document Operations: Create, read, and modify Word documents
• Rich Style System: 18 predefined styles with custom style and inheritance support
• Text Formatting: Full support for fonts, sizes, colors, bold, italic, and more
• Paragraph Format: Alignment, spacing, indentation, and other paragraph properties
• ️ Heading Navigation: Complete support for Heading1-9 styles, recognizable by Word navigation pane
• Table Functionality: Complete table creation, editing, styling, and iterator support
• Page Settings: Page size, margins, headers/footers, and professional layout features
• Advanced Features: Table of contents generation, footnotes/endnotes, list numbering, template engine, etc.
• Template Inheritance: Support for base templates and block override mechanisms for template reuse and extension
• Header/Footer Templates: Support for template variables in headers and footers for dynamic content replacement
• ⚡ Excellent Performance: Zero-dependency pure Go implementation, average 2.62ms processing speed, 3.7x faster than JavaScript, 21x faster than Python
• Easy to Use: Clean API design with fluent interface support

Related Recommended Projects

Excel Document Operations - Excelize

If you need to work with Excel documents, we highly recommend Excelize —— the most popular Go library for Excel operations:

• ⭐ 19.2k+ GitHub Stars - The most popular Excel processing library in the Go ecosystem
• Complete Excel Support - Supports all modern Excel formats including XLAM/XLSM/XLSX/XLTM/XLTX
• Feature Rich - Charts, pivot tables, images, streaming APIs, and more
• High Performance - Streaming read/write APIs optimized for large datasets
• Easy Integration - Perfect complement to WordZero for complete Office document processing solutions

Perfect Combination: WordZero handles Word documents, Excelize handles Excel documents, together providing comprehensive Office document manipulation capabilities for your Go projects.

// WordZero + Excelize combination example
import (
    "github.com/zerx-lab/wordZero/pkg/document"
    "github.com/qax-os/excelize/v2"
)

// Create Word report
doc := document.New()
doc.AddParagraph("Data Analysis Report").SetStyle(style.StyleHeading1)

// Create Excel data sheet
xlsx := excelize.NewFile()
xlsx.SetCellValue("Sheet1", "A1", "Data Item")
xlsx.SetCellValue("Sheet1", "B1", "Value")

Installation

go get github.com/zerx-lab/wordZero

Version Notes

We recommend using versioned installation:

# Install latest version
go get github.com/zerx-lab/wordZero@latest

# Install specific version
go get github.com/zerx-lab/[email protected]

Quick Start

…

Template Inheritance Feature Example

…

Image Placeholder Template Feature Example ✨ New

…

Markdown to Word Feature Example ✨ New

…

" + go // Code block example func main() { fmt.Println("Hello, WordZero!") } + "```" + `

Conversion complete!`

// Convert to Word document
doc, err := converter.ConvertString(markdownText, nil)
if err != nil {
    log.Fatal(err)
}

// Save Word document
err = doc.Save("markdown_example.docx")
if err != nil {
    log.Fatal(err)
}

// File conversion
err = converter.ConvertFile("input.md", "output.docx", nil)
if err != nil {
    log.Fatal(err)
}

}

### Document Pagination and Paragraph Deletion Example ✨ **New**

…

## Documentation and Examples

###  Complete Documentation

**Available in multiple languages**:
- **English**: [ Wiki Documentation](https://github.com/zerx-lab/wordZero/wiki/en-Home)
- **中文**: [ 中文文档](https://github.com/zerx-lab/wordZero/wiki)

**Key Documentation**:
- [** Quick Start**](https://github.com/zerx-lab/wordZero/wiki/en-Quick-Start) - Beginner's guide
- [**⚡ Feature Overview**](https://github.com/zerx-lab/wordZero/wiki/en-Feature-Overview) - Detailed description of all features
- [** Performance Benchmarks**](https://github.com/zerx-lab/wordZero/wiki/en-Performance-Benchmarks) - Cross-language performance comparison analysis
- [**️ Project Structure**](https://github.com/zerx-lab/wordZero/wiki/en-Project-Structure) - Project architecture and code organization

###  Usage Examples
See example code in the `examples/` directory:

- `examples/basic/` - Basic functionality demo
- `examples/style_demo/` - Style system demo  
- `examples/table/` - Table functionality demo
- `examples/formatting/` - Formatting demo
- `examples/page_settings/` - Page settings demo
- `examples/advanced_features/` - Advanced features comprehensive demo
- `examples/template_demo/` - Template functionality demo
- `examples/template_inheritance_demo/` - Template inheritance feature demo ✨ **New**
- `examples/template_image_demo/` - Image placeholder template demo ✨ **New**
- `examples/markdown_conversion/` - Markdown to Word feature demo ✨ **New**
- `examples/pagination_deletion_demo/` - Pagination and paragraph deletion demo ✨ **New**

Run examples:
```bash
# Run basic functionality demo
go run ./examples/basic/

# Run style demo
go run ./examples/style_demo/

# Run table demo
go run ./examples/table/

# Run template inheritance demo
go run ./examples/template_inheritance_demo/

# Run image placeholder template demo
go run ./examples/template_image_demo/

# Run Markdown to Word demo
go run ./examples/markdown_conversion/

Main Features

✅ Implemented Features

• Document Operations: Create, read, save, parse DOCX documents
• Text Formatting: Fonts, sizes, colors, bold, italic, etc.
• Style System: 18 predefined styles + custom style support
• Paragraph Format: Alignment, spacing, indentation, complete support
• Paragraph Management: Paragraph deletion, deletion by index, element removal ✨ New
• Document Pagination: Page break insertion for multi-page document structure ✨ New
• Table Functionality: Complete table operations, styling, cell iterators
• Page Settings: Page size, margins, headers/footers, etc.
• Advanced Features: Table of contents generation, footnotes/endnotes, list numbering, template engine (with template inheritance)
• Image Features: Image insertion, size adjustment, position setting
• Markdown to Word: High-quality Markdown to Word conversion based on goldmark

Planned Features

• Table sorting and advanced operations
• Bookmarks and cross-references
• Document comments and revisions
• Graphics drawing functionality
• Multi-language and internationalization support

View complete feature list: Feature Overview

Performance

WordZero excels in performance, verified through comprehensive benchmarks:

View detailed performance analysis: Performance Benchmarks

Project Structure

…

View detailed structure description: Project Structure

Logo and Branding

The project includes multiple logo variations for different use cases:

Contributing

Issues and Pull Requests are welcome! Please ensure before submitting code:

1. Code follows Go coding standards
2. Add necessary test cases
3. Update relevant documentation
4. Ensure all tests pass

License

This project is licensed under the MIT License. See the LICENSE file for details.

More Resources:

• Complete Documentation
• API Reference
• Best Practices
• Changelog