Panpipe (Panpipe v0.3.0) View Source

An Elixir wrapper around Pandoc.

The Panpipe.Pandoc module implements a wrapper around the Pandoc CLI.

The Panpipe.AST.Node behaviour defines the functions implemented by all nodes of a Panpipe AST.

Link to this section Summary

Functions

Creates the Panpipe AST representation of some input.

Calls ast/2 and delivers the result directly in success case, otherwise raises an error.

Creates an Panpipe.AST.Node of some input without the surrounding Document structure.

Calls ast_fragment/2 and delivers the result directly in success case, otherwise raises an error.

Calls pandoc/1 with the option to: :asciidoc automatically set.

Calls pandoc/1 with the option to: :asciidoctor automatically set.

Calls pandoc/1 with the option to: :beamer automatically set.

Calls pandoc/1 with the option to: :biblatex automatically set.

Calls pandoc/1 with the option to: :bibtex automatically set.

Calls pandoc/1 with the option to: :chunkedhtml automatically set.

Calls pandoc/1 with the option to: :commonmark automatically set.

Calls pandoc/1 with the option to: :commonmark_x automatically set.

Calls pandoc/1 with the option to: :context automatically set.

Calls pandoc/1 with the option to: :csljson automatically set.

Calls pandoc/1 with the option to: :docbook automatically set.

Calls pandoc/1 with the option to: :docbook4 automatically set.

Calls pandoc/1 with the option to: :docbook5 automatically set.

Calls pandoc/1 with the option to: :docx automatically set.

Calls pandoc/1 with the option to: :dokuwiki automatically set.

Calls pandoc/1 with the option to: :dzslides automatically set.

Calls pandoc/1 with the option to: :epub automatically set.

Calls pandoc/1 with the option to: :epub2 automatically set.

Calls pandoc/1 with the option to: :epub3 automatically set.

Calls pandoc/1 with the option to: :fb2 automatically set.

Calls pandoc/1 with the option to: :gfm automatically set.

Calls pandoc/1 with the option to: :haddock automatically set.

Calls pandoc/1 with the option to: :html automatically set.

Calls pandoc/1 with the option to: :html4 automatically set.

Calls pandoc/1 with the option to: :html5 automatically set.

Calls pandoc/1 with the option to: :icml automatically set.

Calls pandoc/1 with the option to: :ipynb automatically set.

Calls pandoc/1 with the option to: :jats automatically set.

Calls pandoc/1 with the option to: :jats_archiving automatically set.

Calls pandoc/1 with the option to: :jats_articleauthoring automatically set.

Calls pandoc/1 with the option to: :jats_publishing automatically set.

Calls pandoc/1 with the option to: :jira automatically set.

Calls pandoc/1 with the option to: :json automatically set.

Calls pandoc/1 with the option to: :latex automatically set.

Calls pandoc/1 with the option to: :man automatically set.

Calls pandoc/1 with the option to: :markdown automatically set.

Calls pandoc/1 with the option to: :markdown_github automatically set.

Calls pandoc/1 with the option to: :markdown_mmd automatically set.

Calls pandoc/1 with the option to: :markdown_phpextra automatically set.

Calls pandoc/1 with the option to: :markdown_strict automatically set.

Calls pandoc/1 with the option to: :markua automatically set.

Calls pandoc/1 with the option to: :mediawiki automatically set.

Calls pandoc/1 with the option to: :ms automatically set.

Calls pandoc/1 with the option to: :muse automatically set.

Calls pandoc/1 with the option to: :native automatically set.

Calls pandoc/1 with the option to: :odt automatically set.

Calls pandoc/1 with the option to: :opendocument automatically set.

Calls pandoc/1 with the option to: :opml automatically set.

Calls pandoc/1 with the option to: :org automatically set.

Calls pandoc/1 with the option to: :pdf automatically set.

Calls pandoc/1 with the option to: :plain automatically set.

Calls pandoc/1 with the option to: :pptx automatically set.

Calls pandoc/1 with the option to: :revealjs automatically set.

Calls pandoc/1 with the option to: :rst automatically set.

Calls pandoc/1 with the option to: :rtf automatically set.

Calls pandoc/1 with the option to: :s5 automatically set.

Calls pandoc/1 with the option to: :slideous automatically set.

Calls pandoc/1 with the option to: :slidy automatically set.

Calls pandoc/1 with the option to: :tei automatically set.

Calls pandoc/1 with the option to: :texinfo automatically set.

Calls pandoc/1 with the option to: :textile automatically set.

Calls pandoc/1 with the option to: :xwiki automatically set.

Calls pandoc/1 with the option to: :zimwiki automatically set.

Link to this section Functions

Link to this function

ast(input_or_opts, opts \\ nil)

View Source

Creates the Panpipe AST representation of some input.

It accepts the same arguments as Panpipe.Pandoc.call/2 which will be called implicitly to get the Pandoc AST representation.

The result is returned in an ok tuple.

Link to this function

ast!(input_or_opts, opts \\ nil)

View Source

Calls ast/2 and delivers the result directly in success case, otherwise raises an error.

Link to this function

ast_fragment(input_or_opts, opts \\ nil)

View Source

Creates an Panpipe.AST.Node of some input without the surrounding Document structure.

Link to this function

ast_fragment!(input_or_opts, opts \\ nil)

View Source

Calls ast_fragment/2 and delivers the result directly in success case, otherwise raises an error.

Link to this function

pandoc(input_or_opts, opts \\ nil)

View Source

See Panpipe.Pandoc.call/2.

Link to this function

pandoc!(input_or_opts, opts \\ nil)

View Source

See Panpipe.Pandoc.call!/2.

Link to this function

to_asciidoc(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :asciidoc automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_asciidoctor(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :asciidoctor automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_beamer(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :beamer automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_biblatex(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :biblatex automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_bibtex(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :bibtex automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_chunkedhtml(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :chunkedhtml automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_commonmark(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :commonmark automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_commonmark_x(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :commonmark_x automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_context(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :context automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_csljson(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :csljson automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_docbook(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :docbook automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_docbook4(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :docbook4 automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_docbook5(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :docbook5 automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_docx(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :docx automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_dokuwiki(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :dokuwiki automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_dzslides(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :dzslides automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_epub(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :epub automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_epub2(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :epub2 automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_epub3(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :epub3 automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_fb2(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :fb2 automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_gfm(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :gfm automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_haddock(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :haddock automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_html(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :html automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_html4(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :html4 automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_html5(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :html5 automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_icml(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :icml automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_ipynb(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :ipynb automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_jats(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :jats automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_jats_archiving(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :jats_archiving automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_jats_articleauthoring(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :jats_articleauthoring automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_jats_publishing(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :jats_publishing automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_jira(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :jira automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_json(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :json automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_latex(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :latex automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_man(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :man automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_markdown(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :markdown automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_markdown_github(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :markdown_github automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_markdown_mmd(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :markdown_mmd automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_markdown_phpextra(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :markdown_phpextra automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_markdown_strict(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :markdown_strict automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_markua(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :markua automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_mediawiki(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :mediawiki automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_ms(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :ms automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_muse(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :muse automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_native(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :native automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_odt(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :odt automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_opendocument(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :opendocument automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_opml(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :opml automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_org(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :org automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_pdf(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :pdf automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_plain(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :plain automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_pptx(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :pptx automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_revealjs(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :revealjs automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_rst(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :rst automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_rtf(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :rtf automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_s5(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :s5 automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_slideous(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :slideous automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_slidy(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :slidy automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_tei(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :tei automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_texinfo(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :texinfo automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_textile(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :textile automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_xwiki(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :xwiki automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

Link to this function

to_zimwiki(input, opts \\ [])

View Source

Calls pandoc/1 with the option to: :zimwiki automatically set.

It also accepts Panpipe.AST.Nodes. pandoc/1 will then be called with Pandoc AST form of the node.

By default the converted output by Pandoc always ends with a newline. This can not be what you want, esp. when you convert small fragments by passing nodes directly. For this reason Panpipe will remove this newline by default for inline nodes, but keeps them on block nodes. You can control whether they should be removed manually with the remove_trailing_newline option.

Note: This function only works with directly passed strings or nodes. If you want to convert a file using the input option, you'll have to read the file first manually or use pandoc/1 directly.

See Panpipe.AST.Node.transform/2.