fogus.text — me.fogus/thneed 1.1.8

md clj

(md s & {:as opts})

Takes a string s containing Markdown-like text and returns a string of the representational HTML.

Supports a minimal and highly constrained Markdown dialect designed specifically for small source code documentation comment blocks. See more information at fogus.me.

It supports two block-level elements:

• CODE BLOCKS: Signaled by four or more leading spaces. The parser preserves all internal formatting and newlines. Content is wrapped in pre and code tags with HTML entities escaped.
• LISTS: Created using a hyphen followed by a space at the start of a line. Lists are terminated by an empty line or the start of a new block-level element. You may use spacing to align continuation text of a given list item, and all will be combined into continuous text. Lists are rendered as ul and li tags. As an example, the two list items in this section are part of a single larger list, but the two list items in the next section constitute two separate lists.

Two inline elements are supported:

• INLINE CODE FRAGMENTS: Literal text wrapped by matching double-backticks. These can be nested within links and lists. Content is wrapped in code tags with HTML entities escaped and white-space trimmed.

• LINKS: Standard Markdown format with square brackets for anchor text and parentheses for URLs. Link text may contain plain text or nested inline code fragments, but no other markup. Links are converted to HTML anchor tags.

All other text is wrapped in paragraph tags. HTML special characters are escaped throughout.

The function also accepts a :language "LANG" keyword arg that, if present will add a class element to all code blocks in the form:

<code class="language-LANG">

Additionally, the :prefix-space N keyword arg takes a number used to 'ignore' the leading N spaces of all text lines. The default value is 2.

Embedded HTML tags are not supported and the rendering behavior when including them in the input text is undefined.

org clj

(org s & {:as opts})

Takes a string s containing Org-mode-like text and returns a string of the representational HTML.

Supports a minimal and highly constrained [[https://orgmode.org][Org-mode]] dialect designed specifically for small source code documentation comment blocks. See more information at fogus.me.

It supports two block-level elements:

• HEADINGS: Lines beginning with one or more asterisks followed by a space become HTML heading tags. The number of asterisks maps directly to the heading level (one asterisk yields h1, two yields h2, and so on up to h6).
• LISTS: Created using a hyphen followed by a space at the start of a line. Lists are terminated by an empty line or the start of a new block-level element. You may use spacing to align continuation text of a given list item, and all will be combined into continuous text. Lists are rendered as ul and li tags. As an example, the two list items in this section are part of a single larger list, but the first two list items in the next section constitute two separate lists.

Three inline elements are supported:

• BOLD: Text wrapped in asterisks (e.g. word) becomes strong.

• ITALIC: Text wrapped in forward-slashes (e.g. /word/) becomes emphasized.

• LINKS: Org-mode double-bracket links of the form [[url][label]] become HTML anchor tags.

The function also accepts a :prefix-spaces N keyword arg that takes a number used to ignore the leading N spaces of every line. The default value is 2.

Embedded HTML tags are not supported and the rendering behavior when including them in the input text is undefined.