DocumenterEpub.MDBlockContext
— TypeMDBlockContext
is a union of all the Markdown nodes whose children should be blocks. It can be used to dispatch on all the block-context nodes at once.
DocumenterEpub.EPUB
— TypeEPUB(;[color=false, lang="en"])
EPUB format Writer.
color
specifies whether or not the code highlighting will be grayscale
or in color.
lang
sets the language in the EPUB.snap_animations
iftrue
replaces the animations with the first frame of it. (currently only works on .gif files)
DocumenterEpub.EPUBContext
— TypeDocumenterEpub
-specific globals that are passed to domify
and other recursive functions.
DocumenterEpub.domify
— MethodConverts recursively a Documents.Page
, Markdown
or Documenter *Node
objects into HTML DOM.
DocumenterEpub.fixlinks!
— MethodReplaces URLs in Markdown.Link
elements (if they point to a local .md
page) with the actual URLs.
DocumenterEpub.get_url
— MethodReturns the full path corresponding to a path of a .md
page file. The the input and output paths are assumed to be relative to src/
.
DocumenterEpub.get_url
— MethodReturns the full path of a Documents.NavNode
relative to src/
.
DocumenterEpub.getpage
— MethodReturns a page (as a Documents.Page
object) using the HTMLContext
.
DocumenterEpub.html_unescape
— Methodhtml_unescape
Internal function to reverse the escaping of some html code (in order to avoid double escaping when pre-rendering with highlight, see issue 326).
DocumenterEpub.mdconvert
— MethodConvert a markdown object to a DOM.Node
object.
The parent
argument is passed to allow for context-dependant conversions.
DocumenterEpub.navhref
— MethodGet the relative hyperlink between two Documents.NavNode
s. Assumes that both Documents.NavNode
s have an associated Documents.Page
(i.e. .page
is not nothing
).
DocumenterEpub.open_output
— FunctionOpens the output file of the navnode
in write node. If necessary, the path to the output file is created before opening the file.
DocumenterEpub.pagetitle
— MethodTries to guess the page title by looking at the <h1>
headers and returns the header contents of the first <h1>
on a page (or nothing
if the algorithm was unable to find any <h1>
headers).
DocumenterEpub.relhref
— MethodCalculates a relative HTML link from one path to another.
DocumenterEpub.render_html
— MethodRenders the main <html>
tag.
DocumenterEpub.render_page
— MethodConstructs and writes the page referred to by the navnode
to .build
.
DocumenterEpub.safeid
— Methodsafeid(page)
Sanitize page
for use in the navigation files toc.xhtml and toc.ncx.
DocumenterEpub.saneid
— Methodsaneid(anchor)
Sanitize the anchor
s id.