scriptling.markdown

The scriptling.markdown library converts Markdown to HTML using the GitHub Flavored Markdown (GFM) specification, backed by goldmark.

Available Functions

Functions

scriptling.markdown.to_html(markdown_string)

Converts a Markdown string to HTML.

Parameters:

• markdown_string (string): The Markdown source to convert.

Returns: string — HTML representation of the Markdown input.

Supported syntax:

• ATX and setext headings
• Bold (**text**), italic (_text_), strikethrough (~~text~~)
• Inline and fenced code blocks (with optional language hint)
• Ordered and unordered lists, nested lists
• Task lists (- [x] done / - [ ] todo)
• Blockquotes
• GFM tables
• Auto-linked bare URLs

Example:

import scriptling.markdown as markdown

html = markdown.to_html("# Hello\n\nThis is **bold** and _italic_.")
# <h1 id="hello">Hello</h1>
# <p>This is <strong>bold</strong> and <em>italic</em>.</p>

Examples

Basic formatting

import scriptling.markdown as markdown

md = """
# Report

Status: **completed**

- Item one
- Item two
  - Nested item
"""

html = markdown.to_html(md)

Table conversion

import scriptling.markdown as markdown

md = """
| Name  | Score |
|-------|-------|
| Alice | 98    |
| Bob   | 75    |
"""

html = markdown.to_html(md)

Fenced code block

import scriptling.markdown as markdown

md = "```python\nprint('hello')\n```"
html = markdown.to_html(md)

Task list

import scriptling.markdown as markdown

md = "- [x] Deploy to staging\n- [ ] Run smoke tests\n- [ ] Deploy to production"
html = markdown.to_html(md)

Convert before writing to an HTML field

import scriptling.markdown as markdown

detail_md = "## Summary\n\nFix deployed to **production**. See [ticket](https://example.com/123)."
detail_html = markdown.to_html(detail_md)
# Pass detail_html to any API that expects HTML content

Notes

• to_html uses goldmark with GFM extensions enabled. The output is safe for insertion into HTML pages — raw HTML in the Markdown source is passed through unchanged, so callers are responsible for sanitising untrusted input before rendering in a browser.
• The function never fails on well-formed UTF-8 Markdown; it raises an exception only if conversion encounters an internal error.