pandoc

Documentation

Index

• type ConvertOptions
• type FetcherOptions
• type File
  • func (p *File) Cleanup()
  • func (p *File) Path() (filename string, err error)
• type Metadata
• type Pandoc
  • func New(conf config.Configuration) (pandoc *Pandoc, err error)
  • func (p *Pandoc) Convert(fetcherOpts FetcherOptions, convertOpts ConvertOptions) (ret []byte, err error)
• type RequestHeader
• type Variable

Types

type ConvertOptions

type ConvertOptions struct {
	From                  string        `json:"from"`
	To                    string        `json:"to"`
	DataDir               string        `json:"data_dir"`
	BaseHeaderLevel       int           `json:"base_header_level"`
	StripEmptyParagraphs  bool          `json:"strip_empty_paragraphs"`
	IndentedCodeClasses   string        `json:"indented_code_classes"`
	Filter                string        `json:"filter"`
	LuaFilter             string        `json:"lua_filter"`
	PreserveTabs          bool          `json:"preserve_tabs"`
	TabStop               int           `json:"tab_stop"`
	TrackChanges          string        `json:"track_changes"` // accept|reject|all
	FileScope             bool          `json:"file_scope"`
	ExtractMedia          string        `json:"extract_media"`
	Standalone            bool          `json:"standalone"`
	Template              string        `json:"template"`
	Metadata              Metadata      `json:"metadata"`
	MetadataFile          string        `json:"metadata_file"`
	Variable              Variable      `json:"variable"`
	PrintDefaultTemplate  string        `json:"print_default_template"`
	PrintDefaultDataFile  string        `json:"print_default_data_file"`
	PrintHighlightStyle   string        `json:"print_highlight_style"`
	DPI                   int           `json:"dpi"`
	EOL                   string        `json:"eol"`  // crlf|lf|native
	Wrap                  string        `json:"wrap"` // auto|none|preserve
	Columns               int           `json:"columns"`
	StripComments         bool          `json:"strip_comments"`
	TOC                   bool          `json:"toc"`
	TOCDepth              int           `json:"toc_depth"`
	NoHighlight           bool          `json:"no_highlight"`
	HighlightStyle        string        `json:"highlight_style"`
	SyntaxDefinition      string        `json:"syntax_definition"`
	IncludeInHeader       string        `json:"include_in_header"`
	IncludeBeforeBody     string        `json:"include_before_body"`
	IncludeAfterBody      string        `json:"include_after_body"`
	ResourcePath          string        `json:"resource_path"`
	RequestHeader         RequestHeader `json:"request_header"`
	SelfContained         bool          `json:"self_contained"`
	HtmlQTags             bool          `json:"html_q_tags"`
	Ascii                 bool          `json:"ascii"`
	ReferenceLinks        bool          `json:"reference_links"`
	ReferenceLocation     string        `json:"reference_location"` // block|section|document
	AtxHeaders            bool          `json:"atx_headers"`
	TopLevelDivision      string        `json:"top_level_division"` // section|chapter|part
	NumberSections        bool          `json:"number_sections"`
	NumberOffset          int           `json:"number_offset"`
	Listings              bool          `json:"listings"`
	Incremental           bool          `json:"incremental"`
	SlideLevel            int           `json:"slide_level"`
	SectionDivs           bool          `json:"section_divs"`
	DefaultImageExtension string        `json:"default_image_extension"`
	EmailObfuscation      string        `json:"email_obfuscation"` // none|javascript|references
	IdPrefix              string        `json:"id_prefix"`
	TitlePrefix           string        `json:"title_prefix"`
	CSS                   string        `json:"css"`
	ReferenceDoc          string        `json:"reference_doc"`
	EpubSubdirectory      string        `json:"epub_subdirectory"`
	EpubCoverImage        string        `json:"epub_cover_image"`
	EpubMetadata          string        `json:"epub_metadata"`
	EpubEmbedFont         string        `json:"epub_embed_font"`
	EpubChapterLevel      int           `json:"epub_chapter_level"`
	PDFEngine             string        `json:"pdf_engine"`
	PDFEngineOpt          string        `json:"pdf_engine_opt"`
	Bibliography          string        `json:"bibliography"`
	CSL                   string        `json:"csl"`
	CitationAbbreviations string        `json:"citation_abbreviations"`
	Natbib                bool          `json:"natbib"`
	Biblatex              bool          `json:"biblatex"`
	Mathml                bool          `json:"mathml"`
	Webtex                string        `json:"webtex"`
	Mathjax               string        `json:"mathjax"`
	Katex                 string        `json:"katex"`
	Latexmathml           string        `json:"latexmathml"`
	Mimetex               string        `json:"mimetex"`
	Jsmath                string        `json:"jsmath"`
	Gladtex               bool          `json:"gladtex"`
	Abbreviations         string        `json:"abbreviations"`
	FailIfWarnings        bool          `json:"fail_if_warnings"`
	// contains filtered or unexported fields
}

type FetcherOptions

type FetcherOptions struct {
	Name   string          `json:"name"`   // http, oss, data
	Params json.RawMessage `json:"params"` // Optional
}

type File

type File struct {
	Url     string
	SafeDir string

	TempDirPrefix string
	// contains filtered or unexported fields
}

func (*File) Cleanup

func (p *File) Cleanup()

func (*File) Path

func (p *File) Path() (filename string, err error)

type Metadata

type Metadata map[string][]string

type Pandoc

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

func New

func New(conf config.Configuration) (pandoc *Pandoc, err error)

func (*Pandoc) Convert

func (p *Pandoc) Convert(fetcherOpts FetcherOptions, convertOpts ConvertOptions) (ret []byte, err error)

type RequestHeader

type RequestHeader map[string]string

type Variable

type Variable map[string]string