latex

package module

v0.0.0-...-31cef3c Latest Latest Go to latest Published: Jul 9, 2024 License: BSD-3-Clause Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-latex/latex

Links

Open Source Insights

README ¶

latex

$go.dev reference$ $GitHub release$ $CI$ $codecov$ $GoDoc$

latex is a package holding Go tools for LaTeX.

latex is supposed to provide features akin to MathJax or matplotlib's TeX capabilities. ie: it is supposed to be able to draw mathematical equations, in pure-Go.

latex is NOT SUPPOSED to be a complete typesetting system like LaTeX or TeX.

For this, please take look at:

Eventually, go-latex/latex might just use star-tex.org/... to provide the MathJax-like capabilities. (once star-tex.org/... is ready and exports a nice Go API.)

Installation

$> go get github.com/go-latex/latex/...

Documentation

Documentation is served by godoc, here:

godoc.org/github.com/go-latex/latex

The main use case for go-latex/latex is to draw a mathematical equation. This is typically achieved via the latex/mtex.Render function that knows how to render mathematical TeX equations to a renderer interface.

Example

package main

import (
	"os"

	"github.com/go-latex/latex/drawtex/drawimg"
	"github.com/go-latex/latex/mtex"
)

func main() {
	f, err := os.Create("output.png")
	if err != nil {
		panic(err)
	}
	defer f.Close()

	dst := drawimg.NewRenderer(f)
	err = mtex.Render(dst, `$f(x) = \frac{\sqrt{x +20}}{2\pi} +\hbar \sum y\partial y$`, 12, 72, nil)
	if err != nil {
		panic(err)
	}

	err = f.Close()
	if err != nil {
		panic(err)
	}
}

LICENSE

BSD-3.

Documentation ¶

Overview ¶

Package latex provides types and functions to work with LaTeX.

Index ¶

func ParseExpr(x string) (ast.Node, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ParseExpr ¶

func ParseExpr(x string) (ast.Node, error)

ParseExpr parses a simple LaTeX expression.

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
ast Package ast declares the types used to represent syntax trees for LaTeX documents.	Package ast declares the types used to represent syntax trees for LaTeX documents.
cmd
mtex-render Command mtex-render renders a LaTeX math expression to a PNG, PDF, ...	Command mtex-render renders a LaTeX math expression to a PNG, PDF, ...
drawtex Package drawtex describes the graphics interface for drawing LaTeX.	Package drawtex describes the graphics interface for drawing LaTeX.
drawimg Package drawimg implements a canvas for img.	Package drawimg implements a canvas for img.
drawpdf Package drawpdf implements a canvas for PDF.	Package drawpdf implements a canvas for PDF.
font Package font holds types to handle and abstract away font management.	Package font holds types to handle and abstract away font management.
liberation Package liberation provides a ttf.Fonts value populated with Liberation fonts.	Package liberation provides a ttf.Fonts value populated with Liberation fonts.
lm Package lm provides a ttf.Fonts value populated with latin-modern, a LaTeX-looking font.	Package lm provides a ttf.Fonts value populated with latin-modern, a LaTeX-looking font.
ttf Package ttf provides a truetype font Backend	Package ttf provides a truetype font Backend
internal
fakebackend Package fakebackend provides a fake tex Backend for testing purposes.	Package fakebackend provides a fake tex Backend for testing purposes.
tex2unicode Package tex2unicode provides tools for associating TeX symbols to UTF-8.	Package tex2unicode provides tools for associating TeX symbols to UTF-8.
mtex Package mtex provides tools to render LaTeX math expressions.	Package mtex provides tools to render LaTeX math expressions.
symbols Package symbols contains logic about TeX symbols.	Package symbols contains logic about TeX symbols.
tex Package tex provides a TeX-like box model.	Package tex provides a TeX-like box model.
token Package token defines constants representing the lexical tokens of LaTeX documents.	Package token defines constants representing the lexical tokens of LaTeX documents.