README
¶
Maroto V2
A Maroto way to create PDFs. Maroto is inspired in Bootstrap and uses Gofpdf. Fast and simple.
Maroto definition: Brazilian expression, means an astute/clever/intelligent person.
You can write your PDFs like you are creating a site using Bootstrap. A Row may have many Cols, and a Col may have many components. Besides that, pages will be added when content may extrapolate the useful area. You can define a header which will be added always when a new page appear, in this case, a header may have many rows, lines or tablelist.
- You can see the full documentation here.
- Discussions are being addressed in this issue.
Installation
- With
go get:
go get github.com/johnfercher/maroto/v2/pkg@v2.0.0-alpha.10
Contributing
| Command | Description | Dependencies |
|---|---|---|
make build |
Build project | go |
make test |
Run unit tests | go |
make fmt |
Format files | gofmt, gofumpt and goimports |
make lint |
Check files | golangci-lint |
make dod |
(Definition of Done) Format files and check files | Same as make build, make test, make fmt and make lint |
make install |
Install all dependencies | go, curl and git |
make font |
Extract font ut8 to use in development | tar |
make examples |
Run all examples | go |
make mock |
Generate mocks | go and mockery |
make docs |
Run docs serve local | docsify |
Stargazers over time
Directories
¶
| Path | Synopsis |
|---|---|
|
Package docs is the documentation of pkg.
|
Package docs is the documentation of pkg. |
|
assets/examples/barcodegrid/v2
command
|
|
|
assets/examples/billing/v2
command
|
|
|
assets/examples/cellstyle/v2
command
|
|
|
assets/examples/customfont/v2
command
|
|
|
assets/examples/customsize/v2
command
|
|
|
assets/examples/footer/v2
command
|
|
|
assets/examples/header/v2
command
|
|
|
assets/examples/imagegrid/v2
command
|
|
|
assets/examples/margins/v2
command
|
|
|
assets/examples/maxgridsum/v2
command
|
|
|
assets/examples/qrgrid/v2
command
|
|
|
assets/examples/signaturegrid/v2
command
|
|
|
assets/examples/textgrid/v2
command
|
|
|
assets/go/basics/base64
command
|
|
|
assets/go/basics/bytes
command
|
|
|
assets/go/basics/metrics
command
|
|
|
assets/go/basics/save
command
|
|
|
assets/go/config/debug
command
|
|
|
assets/go/config/dimensions
command
|
|
|
assets/go/config/margins
command
|
|
|
assets/go/config/maxgridsize
command
|
|
|
assets/go/config/pagesize
command
|
|
|
assets/go/config/parallel
command
|
|
|
code
nolint: dupl
|
nolint: dupl |
Click to show internal directories.
Click to hide internal directories.