tex2pdf

README

tex2pdf

Package tex2pdf provides functions to compile Tex Files into a PDF via XeLaTex engine.

Requirements

• Install TexLive

  tex2pdf calls xelatex command which comes with installation of TexLive. Download and install TexLive("scheme-full" is recommended).

• Install minted pacakge and pygments minted is used for code highlighting. Our test case includes compiling .tex file which uses minted for code highlighting("src/02-usage.tex").

  • Download and Install pygments which is required by minted.
  • TexLive Installation with "scheme-full" includes minted.

Docs

• https://pkg.go.dev/github.com/northbright/tex2pdf

Documentation

Index

• Variables
• type Compiler
  • func New(texFile, outputPDF string, options ...Option) *Compiler
  • func (c *Compiler) Compile() error
• type Option
  • func Stderr(stderr io.Writer) Option
  • func Stdout(stdout io.Writer) Option

Examples

• Compiler.Compile

Variables

var (
	ErrXelatexNotExist = errors.New("xelatex does not exists")
	ErrNoOutputPDF     = errors.New("xelatex compiled successfully but no output pdf found")
)

Types

type Compiler

type Compiler struct {
	// contains filtered or unexported fields
}

Compiler reads main LaTex file and compiles all LaTex files to a PDF.

func New

func New(texFile, outputPDF string, options ...Option) *Compiler

New creates a new compiler.

func (*Compiler) Compile

func (c *Compiler) Compile() error

Compile compiles all LaTex files to a PDF.

Example

package main

import (
	"log"

	"github.com/northbright/tex2pdf"
)

func main() {
	texFile := "example/src/my_book.tex"
	outputPDF := "output/my_book.pdf"

	// Create a compiler with specified stdout and stderr options.
	// c := tex2pdf.New(texFile, outputPDF, tex2pdf.Stdout(os.Stdout), tex2pdf.Stderr(os.Stderr))
	// Create a compiler.
	c := tex2pdf.New(texFile, outputPDF)

	log.Printf("start compiling Tex File to PDF...\nTex file: %v\noutput PDF: %v", texFile, outputPDF)
	// Compile a Tex file to a PDF.
	if err := c.Compile(); err != nil {
		log.Printf("Compile() error: %v", err)
		return
	}

	log.Printf("compile successfully")

}

type Option

type Option func(c *Compiler)

Option represents the option of compiler.

func Stderr

func Stderr(stderr io.Writer) Option

Stderr returns option to set stderr of the cmd to run xelatex.

func Stdout

func Stdout(stdout io.Writer) Option

Stdout returns option to set stdout of the cmd to run xelatex.