Some DocBook XML elements are treated in a particular way when publishing to Markdown. This can be because of specific Markdown requirements, or because there is no Markdown equivalent for said elements.
Admonitions (such as Tips or Cautions) with titles, as well as all Notice and Danger admonitions are rendered as regular Markdown blockquotes. Notes, warnings and other admonitions that have an equivalent in Markdown, will be rendered as such.
A regular Note
A Note with a title, output as a regular Markdown blockquote
The following info elements are supported in Markdown output:
-
abstract -
copyright -
subtitle -
title
These info elements are output as a Markdown header table.
Setting the numeration style (such as loweralpha, or lowerroman) does not affect the Markdown output, since they are not supported in Github Flavored Markdown. Instead, the default style defined by the browser is used.
Many inline styles and XML elements do not have logical counterparts in Markdown. They will therefore be rendered as plain text. The list below is not exhaustive, but lists some of the most often used styles and elements for which there is no Markdown equivalent.
-
Overline (style)
-
guilabel -
tag -
bibliography and sybelements
There are a few limitations in Markdown concerning tables:
-
Table footer rows are converted to regular table rows.
-
Table titles and captions will be placed below the table, unless the table contains cell-spans (merged cells), in which case they will be placed above the table.
-
Width and alignment information for tables will be discarded.
-
A table without. header row will automatically get an empty header row in the Markdown output, since Markdown syntax requires a header row.
In some cases, Markdown publishing will insert an embedded HTML table instead of a native Markdown table. This happens in the following cases:
-
The table has one or more rows and/or columns spanning cells.
-
The table has cells that contain more than a single item (such as multiple paragraphs).
Since Markdown has no way of natively handling these cases, it will revert to an HTML table instead. Note that embedded HTML tables are fully supported in the GitHub flavor of Markdown.
Comments
0 comments
Article is closed for comments.