pandoc

README

PANDOC

If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Pandoc can convert between the following formats:

(← = conversion from; → = conversion to; ↔︎ = conversion from and to)

Pandoc understands a number of useful markdown syntax extensions, including document metadata (title, author, date); footnotes; tables; definition lists; superscript and subscript; strikeout; enhanced ordered lists (start number and numbering style are significant); running example lists; delimited code blocks with syntax highlighting; smart quotes, dashes, and ellipses; markdown inside HTML blocks; and inline LaTeX. If strict markdown compatibility is desired, all of these extensions can be turned off.

Install PanDoc

To install PanDoc you can refer to official PanDoc Documentation.

Samples

To HTML Slides

pandoc -s --mathml -i -t dzslides SLIDES -o example16a.html
pandoc -s --webtex -i -t slidy SLIDES -o example16b.html
pandoc -s --mathjax -i -t revealjs SLIDES -o example16d.html

Documentation

Index

• type PanDocExec
  • func NewExec(execPath string) *PanDocExec
  • func (instance *PanDocExec) Convert(source, sourceFormat, target, targetFormat string, standAlone bool, ...) (response string, err error)
  • func (instance *PanDocExec) ConvertMarkdown(source, targetFormat string, standAlone bool) (response string, err error)
  • func (instance *PanDocExec) ConvertSlides1(source string, standAlone, interactive bool) (response string, err error)
  • func (instance *PanDocExec) ConvertSlides2(source string, standAlone, interactive bool) (response string, err error)
  • func (instance *PanDocExec) ConvertSlides3(source string, standAlone, interactive bool) (response string, err error)
  • func (instance *PanDocExec) ConvertToFile(source, target string, standAlone bool) (response string, err error)
  • func (instance *PanDocExec) ConvertToFileMarkdown(source, target string, standAlone bool) (response string, err error)
  • func (instance *PanDocExec) ConvertToFileSlides1(source, target string, standAlone, interactive bool) (response string, err error)
  • func (instance *PanDocExec) ConvertToFileSlides2(source, target string, standAlone, interactive bool) (response string, err error)
  • func (instance *PanDocExec) ConvertToFileSlides3(source, target string, standAlone, interactive bool) (response string, err error)
  • func (instance *PanDocExec) ConvertToFileSlides4(source, target string, standAlone, interactive bool) (response string, err error)
  • func (instance *PanDocExec) ConvertToFileSlides5(source, target string, standAlone, interactive bool) (response string, err error)
  • func (instance *PanDocExec) ExecuteCommand(arguments ...string) (out string, err error)
  • func (instance *PanDocExec) GetPath(path string) (response string)
  • func (instance *PanDocExec) GetTempPath(subPath string) (response string)
  • func (instance *PanDocExec) GetWorkPath(subPath string) (response string)
  • func (instance *PanDocExec) Help() (string, error)
  • func (instance *PanDocExec) IsInstalled() bool
  • func (instance *PanDocExec) Root() string
  • func (instance *PanDocExec) SetRoot(dir string) *PanDocExec
  • func (instance *PanDocExec) SetSubTemp(enabled bool) *PanDocExec
  • func (instance *PanDocExec) SetTemp(dir string) *PanDocExec
  • func (instance *PanDocExec) SetWorkPath(dir string) *PanDocExec
  • func (instance *PanDocExec) Temp() string
  • func (instance *PanDocExec) Version() (string, error)
  • func (instance *PanDocExec) Work() string
• type PanDocHelper
  • func (instance *PanDocHelper) IsInstalled() bool
  • func (instance *PanDocHelper) NewExec() *PanDocExec
  • func (instance *PanDocHelper) Version() (version string, err error)

Types

type PanDocExec

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

func NewExec

func NewExec(execPath string) *PanDocExec

func (*PanDocExec) Convert

func (instance *PanDocExec) Convert(source, sourceFormat, target, targetFormat string, standAlone bool, options ...string) (response string, err error)

func (*PanDocExec) ConvertMarkdown

func (instance *PanDocExec) ConvertMarkdown(source, targetFormat string, standAlone bool) (response string, err error)

func (*PanDocExec) ConvertSlides1

func (instance *PanDocExec) ConvertSlides1(source string, standAlone, interactive bool) (response string, err error)

ConvertSlides1 uses DzSlides

func (*PanDocExec) ConvertSlides2

func (instance *PanDocExec) ConvertSlides2(source string, standAlone, interactive bool) (response string, err error)

ConvertSlides2 uses DzSlides

func (*PanDocExec) ConvertSlides3

func (instance *PanDocExec) ConvertSlides3(source string, standAlone, interactive bool) (response string, err error)

ConvertSlides3 uses RevealJs

func (*PanDocExec) ConvertToFile

func (instance *PanDocExec) ConvertToFile(source, target string, standAlone bool) (response string, err error)

func (*PanDocExec) ConvertToFileMarkdown

func (instance *PanDocExec) ConvertToFileMarkdown(source, target string, standAlone bool) (response string, err error)

func (*PanDocExec) ConvertToFileSlides1

func (instance *PanDocExec) ConvertToFileSlides1(source, target string, standAlone, interactive bool) (response string, err error)

ConvertToFileSlides1 uses DzSlides

func (*PanDocExec) ConvertToFileSlides2

func (instance *PanDocExec) ConvertToFileSlides2(source, target string, standAlone, interactive bool) (response string, err error)

ConvertToFileSlides2 uses Slidy

func (*PanDocExec) ConvertToFileSlides3

func (instance *PanDocExec) ConvertToFileSlides3(source, target string, standAlone, interactive bool) (response string, err error)

ConvertToFileSlides3 uses RevealJs

func (*PanDocExec) ConvertToFileSlides4

func (instance *PanDocExec) ConvertToFileSlides4(source, target string, standAlone, interactive bool) (response string, err error)

ConvertToFileSlides4 uses Slideous

func (*PanDocExec) ConvertToFileSlides5

func (instance *PanDocExec) ConvertToFileSlides5(source, target string, standAlone, interactive bool) (response string, err error)

ConvertToFileSlides5 uses S5

func (*PanDocExec) ExecuteCommand

func (instance *PanDocExec) ExecuteCommand(arguments ...string) (out string, err error)

func (*PanDocExec) GetPath

func (instance *PanDocExec) GetPath(path string) (response string)

func (*PanDocExec) GetTempPath

func (instance *PanDocExec) GetTempPath(subPath string) (response string)

func (*PanDocExec) GetWorkPath

func (instance *PanDocExec) GetWorkPath(subPath string) (response string)

func (*PanDocExec) Help

func (instance *PanDocExec) Help() (string, error)

func (*PanDocExec) IsInstalled

func (instance *PanDocExec) IsInstalled() bool

func (*PanDocExec) Root

func (instance *PanDocExec) Root() string

func (*PanDocExec) SetRoot

func (instance *PanDocExec) SetRoot(dir string) *PanDocExec

func (*PanDocExec) SetSubTemp

func (instance *PanDocExec) SetSubTemp(enabled bool) *PanDocExec

func (*PanDocExec) SetTemp

func (instance *PanDocExec) SetTemp(dir string) *PanDocExec

func (*PanDocExec) SetWorkPath

func (instance *PanDocExec) SetWorkPath(dir string) *PanDocExec

func (*PanDocExec) Temp

func (instance *PanDocExec) Temp() string

func (*PanDocExec) Version

func (instance *PanDocExec) Version() (string, error)

func (*PanDocExec) Work

func (instance *PanDocExec) Work() string

type PanDocHelper

type PanDocHelper struct {
}

var (
	PanDoc *PanDocHelper
)

func (*PanDocHelper) IsInstalled

func (instance *PanDocHelper) IsInstalled() bool

func (*PanDocHelper) NewExec

func (instance *PanDocHelper) NewExec() *PanDocExec

NewExec Creates new pm2 command

func (*PanDocHelper) Version

func (instance *PanDocHelper) Version() (version string, err error)