Markdown Sample

This is a sample Document.Factory document containing Markdown content.

File Content

The first line of a file is a header that specifies the kind of information contained in the file - in this case, the reserved word markdown specifies that this contains text that conforms to the markdown specification.

Document.Factory extends the markdown format with the addition of an optional YAML header, very much in a similar vein to Jekyll.

If present, the YAML header is separated from the Markdown content by a line starting with ---. The YAML header may be empty, in which case the divider will appear on the second line of the file.

To customize the generated HTML, you may define the following values in the YAML header:

title - specifies the title to include in the <head> of the generated HTML file.

css - specifies the id of a css fragment to include in the output html.

Other data included in the YAML header is ignored.

How it works

  1. The Markdown fragment is rendered into HTML
  2. The HTML is written into an output file

Further information

For more information about Markdown, see the following links: