godocx

README

Godocx

Godocx is a Golang library for creating and modifying DOCX (Microsoft Word) documents.

Usage

Here's a simple example of how you can use Godocx to create and modify DOCX documents:

package main

import (
	"log"

	"github.com/gomutex/godocx"
)

func main() {
	// Open an existing DOCX document
	docx, err := godocx.OpenDocument("./testdata/test.docx")
	if err != nil {
		log.Fatal(err)
	}

	// Add a new paragraph to the document
	_ = docx.AddParagraph("Hello World")
	p := docx.AddEmptyParagraph()
	_ = p.AddText("Add Paragraph and get `Run` instance")

	// Add Heading
	docx.AddHeading("Example Heading", 1) // Heading text and level

	// Save the modified document to a new file
	err = docx.SaveTo("./test_modified.docx")
	if err != nil {
		log.Fatal(err)
	}
}

Examples

Explore additional examples and use cases over at GitHub repository dedicated to showcasing the capabilities of Golang Docx: https://github.com/gomutex/godocx-examples

Inspiration

This GoDocx Library draws inspiration from two renowned libraries in the programming world - python-docx and docx-rs (Rust).

Documentation

Index

• func NewDocument() (*oxml.RootDoc, error)
• func OpenDocument(fileName string) (*oxml.RootDoc, error)

Functions

func NewDocument

func NewDocument() (*oxml.RootDoc, error)

NewDocument creates a new document from the default template.

func OpenDocument

func OpenDocument(fileName string) (*oxml.RootDoc, error)

OpenDocument opens a document from the given file name.