Crate simple_markdown_parser

Source
Expand description

§simple-markdown-parser

LOC badge crates.io badge docs.rs badge

Uses

  • no dependencies
  • no allocations

TODO

  • Block actions
  • YAML parsing for frontmatter
  • HTML parsing
  • Ordered lists
  • List depth for emit
  • “*” and “+” for lists (under options)
  • Escaped code marks code
  • Titles in links
  • Highlight

Additionally

  • CLI via example
  • Python?
  • Iterators and state machines. Does the text decoration cover enough?
  • Performance benchmark

Modules§

extras
utilities

Structs§

CommandBlock
ParseOptions
PartsIterator
Work in progress abstraction for iterating over markdown text sections giving decoration (bold, links, etc) information TODO WIP
RawMarkdown
RawText
(unsplit) Text inside markdown item
Table
TableRow

Enums§

MarkdownElement
Markdown block element
MarkdownTextElement
Some are prefixes, some are wrapped

Functions§

parse
Errors
parse_with_options
Parse source using callback
strip_surrounds