The p:markdown-to-html
step converts a text document in Markdown to XHTML.
Summary
Input port | Primary | Sequence | Content types |
---|---|---|---|
source | ✔ | text |
Output port | Primary | Sequence | Content types |
---|---|---|---|
result | ✔ | html |
Option name | Type | Default value |
---|---|---|
parameters | map(xs:QName, item()*)? | () |
Implementation details
Implementation | Description |
---|---|
Defined | The flavor(s) of Markdown supported and the parameters allowed are implementation-defined. |
Declaration
<p:declare-step
type
="
p:markdown-to-html
"
>
<p:input
port
="
source
"
primary
="
true
"
content-types
="
text
"
/>
<p:output
port
="
result
"
primary
="
true
"
content-types
="
html
"
/>
<p:option
name
="
parameters
"
as
="
map(xs:QName, item()*)?
"
/>
</p:declare-step>
The p:markdown-to-html
step transforms a text document containing Markdown, for example [CommonMark], into HTML. The flavor(s) of Markdown supported and the parameters allowed are implementation-defined.
Document properties
No document properties are preserved.
A. Conformance
Conformant processors must implement all of the features described in this specification except those that are explicitly identified as optional.
Some aspects of processor behavior are not completely specified; those features are either implementation-dependent or implementation-defined.
[Definition: An implementation-dependent feature is one where the implementation has discretion in how it is performed. Implementations are not required to document or explain how implementation-dependent features are performed.]
[Definition: An implementation-defined feature is one where the implementation has discretion in how it is performed. Conformant implementations must document how implementation-defined features are performed.]
The following features are implementation-defined:
- The flavor(s) of Markdown supported and the parameters allowed are implementation-defined. See Section 2.1, “p:markdown-to-html”.
B. References
[CommonMark] CommonMark Spec. John MacFarlane. 6 April 2019.
[XProc 3.1] XProc 3.1: An XML Pipeline Language. Norman Walsh, Achim Berndzen, Gerrit Imsieke and Erik Siegel, editors.
C. Glossary
- implementation-defined
An implementation-defined feature is one where the implementation has discretion in how it is performed. Conformant implementations must document how implementation-defined features are performed.
- implementation-dependent
An implementation-dependent feature is one where the implementation has discretion in how it is performed. Implementations are not required to document or explain how implementation-dependent features are performed.
D. Ancillary files
This specification includes by reference a number of ancillary files.
- steps.xpl
An XProc step library for the declared steps.