RNGKing/marked_one

A simple markdown parser written in pure gleam.

Marked One

What is Marked One?

Marked one is intended to be an simple interface where you pass in markdown held, and you will receive a traversable abstract syntax tree in return. This library is in its EXTREMELY early stages and will need some decent work to get it into a usable state.

PRs open!

This is based on the simple markdown syntax currently supported by Github:

TO-DO LIST

• Create Repository
• Support Paragraphs
• Support Headings
• Support Blockquotes
• Support Images
• Support Links
• Support Code
• Support Lists
• Support Code blocks
• Support Tables
• Support Task List
• Support Footnote
• Support JumpToSection
• Support Horizontal Lines
• Support Inline HTML as well?

Quick start

gleam run   # Run the project
gleam test  # Run the tests
gleam shell # Run an Erlang shell

Installation

Not available on Hex just yet, but we're trying to get there.

When we do please add marked_one to your project using:

gleam add marked_one

and its documentation can be found at https://hexdocs.pm/marked_one.