tmd

README

This is a lib for formatting TapirMD documents and generating HTML pages from TapirMD documents.

TapirMD homepage: https://tmd.tapirgames.com

Documentation

Overview

The package is a simple implementation which is mainly for "tmd fmt" and "tmd gen" commands.

The APIs provided in the lib package is not concurrently safe.

Index

• type HtmlGenOptions
• type Lib
  • func NewLib() (*Lib, error)
  • func (lib *Lib) Destroy()
  • func (lib *Lib) Format(_ TmdFormatOptions) (formattedData []byte, err error)
  • func (lib *Lib) FormatTmd(tmdData []byte, _ TmdFormatOptions) (formattedData []byte, err error)
  • func (lib *Lib) GenerateHtml(options HtmlGenOptions) (htmlData []byte, err error)
  • func (lib *Lib) GenerateHtmlFromTmd(tmdData []byte, options HtmlGenOptions) (htmlData []byte, err error)
  • func (lib *Lib) GenerateTitle(_ TitleGenOptions) (title []byte, err error)
  • func (lib *Lib) SetInputTmd(tmdData []byte) error
  • func (lib *Lib) Version() (version []byte, err error)
• type TitleGenOptions
• type TmdFormatOptions

Types

type HtmlGenOptions

type HtmlGenOptions struct {
	// Enabled custom app name list.
	// Comma or semocolon seperated.
	// Now, only "html" is supported.
	EnabledCustomApps string `json:"enabledCustomApps"`
	// A suffix which will be appended to all HTML id attribute values.
	IdentSuffix string `json:"identSuffix"`
	// A suffix which will be appended to all auto-generated HTML id attribute values.
	AutoIdentSuffix string `json:"autoIdentSuffix"`
	// Whether or not render the root block.
	RenderRoot bool `json:"renderRoot"`
}

The options used in HTML generation.

type Lib

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

All methods of Lib are not concurently safe.

func NewLib

func NewLib() (*Lib, error)

NewLib creates a Lib. If it succeeds, call Lib.Destroy method to release the resouce.

func (*Lib) Destroy

func (lib *Lib) Destroy()

Destroy releases the resource allocated for a Lib.

func (*Lib) Format

func (lib *Lib) Format(_ TmdFormatOptions) (formattedData []byte, err error)

Format formats the current set input TMD. formattedData == null means nothing is done in the formatting.

func (*Lib) FormatTmd

func (lib *Lib) FormatTmd(tmdData []byte, _ TmdFormatOptions) (formattedData []byte, err error)

FormatTmd formats a TMD document. formattedData == null means nothing is done in the formatting.

func (*Lib) GenerateHtml

func (lib *Lib) GenerateHtml(options HtmlGenOptions) (htmlData []byte, err error)

GenerateHtml converts the current set input TMD into HTML.

func (*Lib) GenerateHtmlFromTmd

func (lib *Lib) GenerateHtmlFromTmd(tmdData []byte, options HtmlGenOptions) (htmlData []byte, err error)

GenerateHtmlFromTmd converts a TMD document into HTML.

func (*Lib) GenerateTitle

func (lib *Lib) GenerateTitle(_ TitleGenOptions) (title []byte, err error)

GenerateTitle retrieves the title of the current set input TMD. A nil title means the current set input TMD doesn't define a title.

func (*Lib) SetInputTmd

func (lib *Lib) SetInputTmd(tmdData []byte) error

SetInputTmd prepares the input TMD data for later using.

func (*Lib) Version

func (lib *Lib) Version() (version []byte, err error)

Version returns the version of library.

type TitleGenOptions

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

Blank now. Just for backward compatibility.

type TmdFormatOptions

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

Blank now. Just for backward compatibility.