Skip to content
forked from brecert/nevula

A (relatively) simple and (hopefully) performant markup parser

Notifications You must be signed in to change notification settings

Nerimity/nevula

 
 

Repository files navigation

Nevula

A (relatively) simple and (hopefully) performant markup parser made for nerimity.

Please note, this is not a markdown parser, this is its own special markup format called nevula, a specification for this format is a work in progress.

This project has grown out of a need for a relatively simple renderer agnostic, reasonably performant markup parser with a relatively small code size.

Features

renderer agnostic

The outputted entity format is fairly simple and has been designed to make it easy to make renderers for.

relatively simple

This may change over time, but for now it only parses a fairly restricted set of rules intented to make sense.

An example of this is the italic syntax, // looks slanted like italicized text and two slashes are used to be consistent with other rules and to make it easier to avoid conflicts with other text.

reasonably performant

see: Benchmarks

Benchmarks

Just to be clear, many types of benchmarks will favour this markup because of it's smaller surface area compared to something like a full markdown parser.

Simple Markup

> **Hello world!**

**__inside__ __inside again__**

``code``

** ~~not~~ a complete marker! __complete__
Name Runs Total (ms) Average (ms)
nevula 2500 153.699 0.061
nevula with inserted text spans 2500 159.208 0.064
/x/markdown@v2.0.0 (based on an older version of Marked) 2500 284.173 0.114

About

A (relatively) simple and (hopefully) performant markup parser

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • TypeScript 50.7%
  • JavaScript 49.3%