Writers
#Documenter.Writers
— Module.
Provides a rendering function, render
, for writing each supported Formats.Format
to file.
Note that currently Formats.Markdown
is the only supported format.
#Documenter.Writers.Writer
— Type.
A parametric type that allows us to use multiple dispatch to pick the appropriate writer for each output format.
The parameter f
should be an instance of the Formats.Format
enumeration.
#Documenter.Writers.render
— Method.
Writes a Documents.Document
object to .user.build
directory in the format specified in .user.format
.
The method should be overloaded in each writer as
render(::Writer{format}, doc)
where format
is one of the values of the Formats.Format
enumeration.
#Documenter.Writers.MarkdownWriter
— Module.
Provides the render
methods to write the documentation as Markdown files (MIME"text/plain"
).
#Documenter.Writers.HTMLWriter
— Module.
Provides the render
methods to write the documentation as HTML files (MIME"text/html"
).
#Documenter.Writers.HTMLWriter.mdconvert
— Method.
Convert a markdown object to a DOM.Node
object.
The parent
argument is passed to allow for context-dependant conversions.
#Documenter.Writers.LaTeXWriter
— Module.
Provides the render
methods to write the documentation as LaTeX files (MIME"text/latex"
).