sogo

SoGo

Overview

SoGo is a collection of Go utilities for common tasks including PDF generation, HTTP handling, database access, text processing, and more. The library wraps various Go packages to provide simpler, more consistent APIs.

Originally extracted from github.com/grokify/mogo to reduce dependency overhead, sogo focuses on providing useful wrappers with minimal transitive dependencies.

Installation

go get github.com/grokify/sogo

Packages

Usage Examples

PDF with Background Image and Text Overlay

Create a PDF with a background image, logo, and styled text:

import "github.com/grokify/sogo/pdf"

opts := pdf.BackgroundPDFOptions{
    PageSize: pdf.PageSizeLetter,
    TextStyle: pdf.TextStyle{
        FontName:   "Helvetica",
        FontSize:   14,
        Color:      "1 1 1", // white
        MarginTop:  200,
        MarginLeft: 72,
        LineHeight: 1.5,
    },
    Logo: &pdf.LogoOptions{
        Position: pdf.LogoPositionTopLeft,
        Scale:    0.3,
    },
    LogoPath: "logo.png",
}

err := pdf.CreateBackgroundPDFFile(
    "background.png",
    "# Title\n\nSubtitle text here",
    opts,
    "output.pdf",
)

Multi-Page PDF with Per-Segment Styling

Create multi-page PDFs with different styles per text block:

pages := []pdf.Page{
    {
        BackgroundPath: "cover-bg.png",
        LogoPath:       "logo.png",
        Logo:           &pdf.LogoOptions{Position: pdf.LogoPositionTopLeft, Scale: 0.3},
        TextBlocks: []pdf.TextBlock{
            {Text: "Document Title", FontSize: 28, Color: "1 1 1"},
            {Text: "Subtitle", FontSize: 20, Color: "1 1 1"},
        },
        TextStyle: pdf.TextStyle{MarginTop: 200, MarginLeft: 72},
    },
    {
        // White page (no background)
        TextBlocks: []pdf.TextBlock{
            {Text: "Chapter 1", FontSize: 18, Color: "0 0 0"},
            {Text: "Content goes here...", FontSize: 12, Color: "0 0 0"},
        },
        TextStyle: pdf.TextStyle{MarginTop: 72, MarginLeft: 72},
    },
}

err := pdf.CreateMultiPagePDFFile(pages, pdf.PageSizeLetter, "document.pdf")

Markdown to PDF

Convert markdown files to PDF:

import "github.com/grokify/sogo/text/markdown/md2pdf"

err := md2pdf.MarkdownToPDFFile("input.md", "output.pdf", 0600)

Documentation

Full API documentation is available on pkg.go.dev.

Changelog

See CHANGELOG.md for release history.

License

MIT License. See LICENSE for details.