https://github.com/brecert/nevula

A (relatively) simple and (hopefully) performant markup parser
https://github.com/brecert/nevula

Last synced: 3 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/brecert/nevula
• Owner: brecert
• Created: 2021-03-06T00:30:27.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-26T17:47:57.000Z (almost 4 years ago)
• Last Synced: 2024-12-09T19:55:41.639Z (29 days ago)
• Language: TypeScript
• Size: 108 KB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# nevula

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

**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)

# Benchmarks

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

## Simple Markup

```md

> **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/[email protected] (based on an older version of Marked)|2500|284.173|0.114|