xrust-md 0.2.2

Parse Markdown and produce a χrust tree
Documentation

χrust-md

crates.io Released API docs ALv2 licensed

A parser for Markdown documents that creates a χrust tree.

Markdown Editing

Markdown is simply text with some embedded instructions.

Headings

A level 1 heading is denoted by a '#' at the beginning of the line.

# A Level 1 Heading

A level 2 heading is denoted by a '##' at the beginning of the line.

## A Level 2 Heading

There is no limit to heading levels.

Paragraphs

The end of the line starts a new paragraph.

The first paragraph.
Followed by another paragraph.

Phrases

For strong (bold) text surround the text with '**'. For underlined text surround the text with '__' (underscores). For emphasised (italic) text surround the texy with '//'.

The **strong** phrase followed by an __underlined__ phrase and then //italics// and then the end of the paragraph.

Usage

This crate is used by χrusty to support Markdown as a source document in a transformation.

Change Log

Release Notes
0.1.0 Initial release
--------- -------
0.2.0 Unlimited heading levels
--------- -------