md2pdf

package

v0.0.7 Latest Latest Go to latest Published: Sep 10, 2019 License: MIT Imports: 12 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/tcd/md2pdf

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Debug(path, debugDir string) error
func MdBytesToPdfFile(mdBytes []byte, outPath string) (string, error)
func MdFileToPdfFile(inPath, outPath string) (string, error)
func MdURLToPdfFile(url, outPath string) (string, error)
type VersionInfo
- func (v VersionInfo) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// VersionMajor is set during build
	VersionMajor string
	// VersionMinor is set during build
	VersionMinor string
	// VersionPatch is set during build
	VersionPatch string
	// VersionHash is set during build
	VersionHash string
	// VersionDate is set during build
	VersionDate string
)

View Source

var Version = VersionInfo{
	Major: VersionMajor,
	Minor: VersionMinor,
	Patch: VersionPatch,
	Hash:  VersionHash,
	Date:  VersionDate,
}

Version is for use in the version subcommand.

Functions ¶

func Debug ¶

func Debug(path, debugDir string) error

Debug outputs not only a PDF, but also HTML and JSON output for debugging.

func MdBytesToPdfFile ¶ added in v0.0.5

func MdBytesToPdfFile(mdBytes []byte, outPath string) (string, error)

MdBytesToPdfFile can be used to render markdown input from stdin. The path to the new PDF file is returned along with any encountered errors.

func MdFileToPdfFile ¶

func MdFileToPdfFile(inPath, outPath string) (string, error)

MdFileToPdfFile converts a markdown file to a PDF file. The path to the new PDF file is returned along with any encountered errors.

func MdURLToPdfFile ¶

func MdURLToPdfFile(url, outPath string) (string, error)

MdURLToPdfFile converts a markdown file at a given URL to a pdf file. The path to the new PDF file is returned along with any encountered errors.

Types ¶

type VersionInfo ¶ added in v0.0.2

type VersionInfo struct {
	Major string
	Minor string
	Patch string
	Hash  string
	Date  string
}

VersionInfo about a build of md2pdf.

func (VersionInfo) String ¶ added in v0.0.2

func (v VersionInfo) String() string

Source Files ¶

View all Source files

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