markup

package module

v0.0.0-...-34485b8 Latest Latest Go to latest Published: Sep 8, 2020 License: MIT Imports: 5 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/IdlePhysicist/markup

README ¶

markup

Markup is a simple tool to facilitate the rendering of markdown to PDF based on LaTeX templates.

Requirements

Markup relies upon pandoc and imagemagick.

Templates

Templates are expected to be stored in ~/.config/markup, and are to be of .tex extension.

Documentation ¶

Index ¶

func FindAllTemplates() error
func FindTemplate(name string) (*file, error)
func Markup(input *file, template *file) error
func OpenFile(input string) (*file, error)
func Xerox(input *file) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FindAllTemplates ¶

func FindAllTemplates() error

FindAllTemplates walks the template directory to find all LaTeX template files present.

func FindTemplate ¶

func FindTemplate(name string) (*file, error)

FindTempate accepts a name of a template and returns a pointer to that file.

func Markup ¶

func Markup(input *file, template *file) error

Markup is a wrapper function around Pandoc that renders the inputted Markdown file to a PDF using Pandoc and a LaTeX template provided by the user. The function accepts the input Markdown file and a LaTeX template file.

func OpenFile ¶

func OpenFile(input string) (*file, error)

OpenFile accepts a path to a file and returns a pointer to the file, if it exists.

func Xerox ¶

func Xerox(input *file) error

Xerox is a wrapper function around ImageMagick's convert that "xeroxes" the PDF to look as though it has been photocopied n times.

Types ¶

This section is empty.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
cmd
cmds

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