# Namespace: joker.markdown

v1.0

## Contents

- Summary
- Index
- Constants
- Variables
- Functions, Macros, and Special Forms

## Summary

Implements GitHub Flavored Markdown rendering.

## Index

- convert-string

## Constants

Constants are variables with `:const true` in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.

(None.)

## Variables

(None.)

## Functions, Macros, and Special Forms

- ### convert-string

  Function v1.0

      (convert-string s)
      (convert-string s opts)

  Returns the HTML rendering of Markdown string s.
  opts is an optional map of boolean rendering options (all default to true)
  :with-hard-wraps? - Render newlines as <br>.
  :with-xhtml? - Render as XHTML.
  :with-unsafe? - When false, all raw html will be omitted from the output. When true html is passed through unchanged.