Module restia.markdown

Markdown auxiliary module.

Allows rendering markdown files directly into the document.

Info:

  • License: Unlicense
  • Author: DarkWiiPlayer

Functions

load (document[, cache=false]) Renders a markdown file.

Local Functions

parsemd (markdown) Parses markdown into HTML
parsemdfile (path) Parses a markdown file.


Functions

load (document[, cache=false])
Renders a markdown file.

Parameters:

  • document string Markdown file (without extension) to load
  • cache boolean Whether to cache the template (default false)

Usage:

    restia.markdown('content')

Local Functions

parsemd (markdown)
Parses markdown into HTML

Parameters:

Returns:

    string

Usage:

    parsemd 'some *fancy* text'
parsemdfile (path)
Parses a markdown file.

Parameters:

  • path string The markdown file to read

Returns:

    string

Usage:

    parsemdfile 'documents/markdown/article.md'
generated by LDoc 1.4.6 Last updated 2021-01-03 16:45:09