Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

59 Commits

Repository files navigation

Micron Parser JS

This repository provides a JavaScript parser for Micron, a lightweight, terminal-friendly markdown format used in NomadNet and MeshChat

Requirements

Micron Parser JS requires DOMpurify for HTML/XSS sanitization. To install DOMpurify, include it with your script tags above micron-parser.js or install via a package manager like NPMnpm install micron-parser

Usage

// Import Micron Parser (requires modules)importMicronParserfrom'./js/micron-parser.js';// Create a new parser (darkTheme = true/false | defaults to true, forceMonospace = true/false | defaults to true)constparser=newMicronParser(true,true);// Input Micron markupconstmicronMarkup=`> Example Heading-∿This is a simple line in Micron.# This line is a comment and won't appear in the output.`;// Convert Micron to an HTML stringconsthtmlOutput=parser.convertMicronToHtml(micronMarkup);// Insert it into your pagedocument.getElementById('yourElement').innerHTML=htmlOutput;// Or create a DocumentFragment from MicronconstdomFragment=parser.convertMicronToFragment(micronMarkup);// and append it to the DOMdocument.body.appendChild(domFragment);

Best practices

For optimal display of Micron content in the browser it's recommended to use a monospaced font with NerdFont icon support, such as the ones provided here.

About

Micron Parser JavaScript implementation

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages