An extended markdown parser written in pure rust

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

trivernis e1f1140aeb Add Anchor element for references to items		5 years ago
src	Add Anchor element for references to items	5 years ago
.gitignore	Add subtext parsing	5 years ago
Cargo.lock	Add Anchor element for references to items	5 years ago
Cargo.toml	Add Anchor element for references to items	5 years ago
LICENSE	Create LICENSE	5 years ago
README.md	Fix escapes of highlighted code	5 years ago

README.md

Snekdown - A wonderful markdown parser

This projects goal is to implement a fast markdown parser with an extended syntax fitted for my needs.

Usage

USAGE:
    snekdown [OPTIONS] <input> <output>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -f, --format <format>     [default: html]

ARGS:
    <input>     
    <output>

Syntax

Images

Simple Syntax
!(url)

Extended syntax with a description
![description](url)

Extended syntax with metadata to specify the size
![description](url)[metadata]

Extended syntax with metadata and no description
!(url)[metadata]

Quotes

Simple (default) Syntax
> This is a quote

Multiline
> This is a 
> Multiline Quote

Quote with metadata (e.g. Author)
[Trivernis - 2020]> This is a quote with metadata

Imports

Imports can be used to import a different document to be attached to the main document. Imports are parsed via multithreading.

<[path]

Tables

Tables MUST start with a pipe character |

Standalone header:
| header | header | header

Header with rows
| header | header | header
|--------|--------|-------
| row    | row    | row