Tcl Library Source Code

Documentation
Login
Bounty program for improvements to Tcl and certain Tcl packages.


[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

NAME

markdown - Converts Markdown text to HTML

Table Of Contents

SYNOPSIS

package require Tcl 8.5
package require Markdown 1.2.2
package require textutil ?0.8?

::Markdown::convert markdown
::Markdown::register langspec converter
::Markdown::get_lang_counter
::Markdown::reset_lang_counter

DESCRIPTION

The package Markdown provides a command to convert Markdown annotated text into HMTL.

Supported markdown syntax

This markdown converter supports the original markdown by Gruber and Swartz (see their syntax page for details):

In addition, the following extended markdown sytax is supported, taken from PHP Markdown Extra and GFM (Github Flavoured Markdown):

Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category textutil of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

CATEGORY

Text processing