# Package-level declarations

## Functions

autopagebreak
Link copied to clipboard

    .autopagebreak maxdepth:{Int} -> Void

Content copied to clipboard

Sets a new automatic page break threshold when a heading is found: if a heading's depth value (the amount of leading `#`s) is equal to or less than maxdepth, a page break is forced before the heading.

captionposition
Link copied to clipboard

    .captionposition default:{CaptionPosition? = null} \
                     figures:{CaptionPosition? = null} \
                      tables:{CaptionPosition? = null} \
                        code:{CaptionPosition? = null}
    -> Void

Content copied to clipboard

Sets the position of captions, relative to the content they describe.

currentpage
Link copied to clipboard

    .currentpage -> Node

Content copied to clipboard

Displays the index (starting from 1) of the page this element lies in.

docauthor
Link copied to clipboard

    .docauthor author:{String? = null} -> Any

Content copied to clipboard

If author is specified, sets the document author to that value. This is a shortcut for docAuthors when there's only one author without additional information.

docauthors
Link copied to clipboard

    .docauthors authors:{Map<String, Dictionary<Any>>? = null} -> Any

Content copied to clipboard

If authors is specified, sets the document authors to that value. Compared to docAuthor, this function allows for multiple authors and additional information.

docdescription
Link copied to clipboard

    .docdescription description:{String? = null} -> Any

Content copied to clipboard

If description is specified, sets the document description to that value.

dockeywords
Link copied to clipboard

    .dockeywords keywords:{Iterable<Dynamic>? = null} -> Any

Content copied to clipboard

If keywords is specified, sets the document keywords to those values. In HTML, keywords are exported to SEO-friendly meta tags.

doclang
Link copied to clipboard

    .doclang locale:{String? = null} -> Any

Content copied to clipboard

If locale is specified, sets the document language to that value. The document language affects localization (localization, localize), hyphenation and other locale-specific properties.

docname
Link copied to clipboard

    .docname name:{String? = null} -> Any

Content copied to clipboard

If name is specified, sets the document name to that value. The document name affects the name of the output file.

doctype
Link copied to clipboard

    .doctype type:{DocumentType? = null} -> Any

Content copied to clipboard

If type is specified, sets the document type to that value. The document type affects its final output style, numbering format and several other properties.

font
Link copied to clipboard

    .font main:{String? = null} \
       heading:{String? = null} \
          code:{String? = null} \
          size:{Size? = null}
    -> Void

Content copied to clipboard

Updates the global font configuration of the document.

footer
Link copied to clipboard

    .footer content:{MarkdownContent} -> Node

Content copied to clipboard

Displays content on the bottom center of each page of a document.

formatpagenumber
Link copied to clipboard

    .formatpagenumber format:{String} -> Node

Content copied to clipboard

Sets a new page number format from the page where this function appears.

lastheading
Link copied to clipboard

    .lastheading depth:{Int} -> Node

Content copied to clipboard

Displays the last heading, of the given depth, encountered in the current page.

marker
Link copied to clipboard

    .marker name:{InlineMarkdownContent} -> Node

Content copied to clipboard

Creates an invisible marker, that points to a specific location in the document, and can be referenced by other elements as would happen with a regular heading.

navigation
Link copied to clipboard

    .navigation role:{NavigationContainer.Role? = null} content:{MarkdownContent} -> Node

Content copied to clipboard

Creates a navigation container, which marks its content as a navigable section.

noautopagebreak
Link copied to clipboard

    .noautopagebreak -> Void

Content copied to clipboard

Disables automatic page breaks when a heading is found.

nonumbering
Link copied to clipboard

    .nonumbering -> Void

Content copied to clipboard

Disables numbering across the document, in case a default numbering is set by either numbering or the document type default.

numbering
Link copied to clipboard

    .numbering merge:{Boolean = true} formats:{Map<String, Any>} -> Void

Content copied to clipboard

Sets the global numbering format across the document. Numbering is applied to elements that support it, such as headings and figures.

pageformat
Link copied to clipboard

    .pageformat side:{PageSide? = null} \
               pages:{Range? = null} \
                size:{PageSizeFormat? = null} \
         orientation:{PageOrientation = context.documentInfo.type.preferredOrientation} \
               width:{Size? = null} \
              height:{Size? = null} \
              margin:{Sizes? = null} \
           bordertop:{Size? = null} \
         borderright:{Size? = null} \
        borderbottom:{Size? = null} \
          borderleft:{Size? = null} \
         bordercolor:{Color? = null} \
          background:{Color? = null} \
             columns:{Int? = null} \
           alignment:{NodeStyle.TextAlignment? = null}
    -> Void

Content copied to clipboard

Sets the page layout format of the document. If a value is unset, the default value supplied by the underlying renderer is used.

pagemargin
Link copied to clipboard

    .pagemargin position:{PageMarginPosition} content:{MarkdownContent} -> Node

Content copied to clipboard

Displays content on each page of a document.

paragraphstyle
Link copied to clipboard

    .paragraphstyle lineheight:{Number? = null} \
                 letterspacing:{Number? = null} \
                       spacing:{Number? = null} \
                        indent:{Number? = null}
    -> Void

Content copied to clipboard

Sets the global style of paragraphs in the document. If a value is unset, the default value supplied by the underlying renderer is used.

resetpagenumber
Link copied to clipboard

    .resetpagenumber start:{Int = 1} -> Node

Content copied to clipboard

Resets the logical page number counter.

tableofcontents
Link copied to clipboard

    .tableofcontents title:{InlineMarkdownContent? = null} \
                  maxdepth:{Int = 3} \
                 breakpage:{Boolean = true} \
              headingdepth:{Int? = null} \
             numberheading:{Boolean = false} \
              indexheading:{Boolean = false} \
                     focus:{InlineMarkdownContent? = null}
    -> Node

Content copied to clipboard

Generates a table of contents, based on the headings in the document, organized in a hierarchical structure defined by each heading's depth.

texmacro
Link copied to clipboard

    .texmacro name:{String} macro:{String} -> Void

Content copied to clipboard

Creates a new global TeX macro that can be accessed within math blocks.

theme
Link copied to clipboard

    .theme color:{String? = null} layout:{String? = null} -> Void

Content copied to clipboard

Sets the document theme.

totalpages
Link copied to clipboard

    .totalpages -> Node

Content copied to clipboard

Displays the total amount of pages in the document.