tclsoldout(3tcl)

💖 tclsoldout — the manual page, but make it cute 💖

okay so bestie, welcome to the tclsoldout(3tcl) page 💅 this is a LOCAL manual page and it's literally all about TclSoldout, the Markdown parser. sit down, grab a strawberry 🍓, we're doing this.

✨ NAME ✨

TclSoldout — Markdown parser 🎀

🌸 SYNOPSIS 🌸

package require TclSoldout [0.1.1]

::soldout::escape_html string

::soldout::mkd2html [-discount | -natext] markdown

::soldout::mkd2xhtml [-discount | -natext] markdown

🦋 DESCRIPTION 🦋

The TclSoldout extension is a Tcl binding to libsoldout, which is a lightweight C library that can parse Markdown. no cap, that's the whole vibe. 🫶

The ::soldout::escape_html command replaces '<', '>', '&' and '"' in the string with their HTML entities and returns the modified text. she's a sanitizer, she's an icon, she's doing the most. ✨

The ::soldout::mkd2html command parses markdown text and returns HTML — and self-closing tags are rendered like this: <br> (iykyk, no slash, she's built different).

The ::soldout::mkd2xhtml command parses markdown text and returns XHTML — self-closing tags look like this: <br /> (yes bestie, the slash IS the moment 💅).

The options are as follows:

• -discount — enable Discount extensions:
  • image size specification, by appending "=(width)x(height)" to the link
  • pseudo-protocols in links:
    • abbr:description for <abbr title="description">...</abbr>
    • class:name for <span class="name">...</span>
    • id:name for <span id="name">...</span>
    • raw:text for verbatim unprocessed text inclusion
  • class blocks: blockquotes beginning with %class% will be rendered as a div of the given class(es)
  • and PHP-Markdown-like tables. 🔥
• -natext — enable Discount extensions and Natasha's own extensions:
  • id attribute for headers, using the syntax id#Header text
  • class attribute for paragraphs, by putting class name(s) between parenthesis at the very beginning of the paragraph
  • <ins> and <del> spans, using respectively ++ and -- as delimiters (with emphasis-like restrictions, i.e. an opening delimiter cannot be followed by a whitespace, and a closing delimiter cannot be preceded by a whitespace)
  • plain <span> without attribute, using emphasis-like delimiter |

⚠️ bestie, listen — -natext is literally -discount plus Natasha's own extensions, so don't go thinking they're rivals, okay? it's giving "and", not "or". 🙈

🌈 SEE ALSO 🌈

• libsoldout: https://github.com/faelys/libsoldout

👑 AUTHORS 👑

TclSoldout was written by Svyatoslav Mishyn <juef@openmailbox.org>. 💜

and that's the whole page, bestie, you ate that 🎀 mwah 💋

this one's from the Debian manual, dated September 11, 2015 — shoutout to the tclsoldout(3tcl) era, she's iconic, she's periodt. ✨🦋💖