mirror of
https://github.com/fumiama/go-docx.git
synced 2026-06-06 00:00:24 +08:00
80 lines
3.3 KiB
Markdown
80 lines
3.3 KiB
Markdown
# Docx library
|
|
|
|
Yet another library to read and write .docx (a.k.a. Microsoft Word documents or ECMA-376 Office Open XML) files in Go.
|
|
|
|
This is a variant optimized and expanded by fumiama. The original repo is [gonfva/docxlib](https://github.com/gonfva/docxlib).
|
|
|
|
## Introduction
|
|
|
|
As part of my work for [Basement Crowd](https://www.basementcrowd.com) and [FromCounsel](https://www.fromcounsel.com), we were in need of a basic library to manipulate (both read and write) Microsoft Word documents.
|
|
|
|
The difference with other projects is the following:
|
|
|
|
- [UniOffice](https://github.com/unidoc/unioffice) is probably the most complete but it is also commercial (you need to pay). It also very complete, but too much for my needs.
|
|
|
|
- [gingfrederik/docx](https://github.com/gingfrederik/docx) only allows to write.
|
|
|
|
There are also a couple of other projects [kingzbauer/docx](https://github.com/kingzbauer/docx) and [nguyenthenguyen/docx](https://github.com/nguyenthenguyen/docx)
|
|
|
|
[gingfrederik/docx](https://github.com/gingfrederik/docx) was a heavy influence (the original structures and the main method come from that project).
|
|
|
|
However, those original structures didn't handle reading and extending them was particularly difficult due to Go xml parser being a bit limited including a [6 year old bug](https://github.com/golang/go/issues/9519).
|
|
|
|
Additionally, my requirements go beyond the original structure and a hard fork seemed more sensible.
|
|
|
|
The plan is to evolve the library, so the API is likely to change according to my company's needs. But please do feel free to send patches, reports and PRs (or fork).
|
|
|
|
In the mean time, shared as an example in case somebody finds it useful.
|
|
|
|
## Getting Started
|
|
|
|
### Install
|
|
|
|
Go modules supported
|
|
|
|
```sh
|
|
go get github.com/fumiama/docxlib
|
|
```
|
|
|
|
### Usage
|
|
|
|
See [main](main/main.go) for an example
|
|
|
|
```
|
|
$ go run ./cmd/main
|
|
Preparing new document to write at /tmp/new-file.docx
|
|
Document writen.
|
|
Now trying to read it
|
|
We've found a new run with the text ->test
|
|
We've found a new run with the text ->test font size
|
|
We've found a new run with the text ->test color
|
|
We've found a new run with the text ->test font size and color
|
|
We've found a new hyperlink with ref http://google.com and the text google
|
|
End of main
|
|
```
|
|
You can also increase the log level (-logtostderr=true -v=0) and just dump a specific file(-file /tmp/new-file.docx). See [getstructure/main](getstructure/main.go)
|
|
```
|
|
$ go build -o docxlib ./cmd/getstructure/ && ./docxlib -logtostderr=true -v=0 -file /tmp/new-file.docx
|
|
I0511 12:37:40.898493 18466 unpack.go:69] Relations: [...]
|
|
I0511 12:37:40.898787 18466 unpack.go:47] Doc: [...]
|
|
I0511 12:37:40.899330 18466 unpack.go:58] Paragraph [0xc000026d40 0xc000027d00 0xc000172340]
|
|
I0511 12:37:40.899369 18466 main.go:31] There is a new paragraph [...]
|
|
We've found a new run with the text ->test
|
|
We've found a new run with the text ->test font size
|
|
We've found a new run with the text ->test color
|
|
I0511 12:37:40.899389 18466 main.go:31] There is a new paragraph [...]
|
|
We've found a new run with the text ->test font size and color
|
|
I0511 12:37:40.899396 18466 main.go:31] There is a new paragraph [...]
|
|
We've found a new hyperlink with ref http://google.com and the text google
|
|
End of main
|
|
```
|
|
### Build
|
|
|
|
```
|
|
$ go build ./...
|
|
```
|
|
|
|
## License
|
|
|
|
MIT. See [LICENSE](LICENSE)
|