Skip to content

A markdown parser and compiler to BBCode. Built for speed (and nerdz.eu)

License

Notifications You must be signed in to change notification settings

winterthediplomat/marked

 
 

Repository files navigation

marked (BBCode)

Mardkown parser and compiler based on chjj/marked.

Member Lab #1: alfateam123
Member Lab #2: cenci0
Future gadget current revision: v0.1 (Asagi)

Asagi-san :3

Usage

Minimal usage:

var marked = require('marked');
console.log(marked('I am using __markdown__.'));
// Outputs: I am using [b]markdown[/b].

New options

nerdz

Type: boolean Default: true

Enable BBCode handling as it is done on nerdz.eu. Basically just some more tags support have been added (rg. [spoiler], [user] and [project]) and other tags grammar has been slightly modified.

Cheatsheet

Markdown BBCode
*italic* [i]text[/i]
**bold** [b]bold[/b]
~~striketrough~~ [s]striketrough[/s] / [del]striketrough[/del]
# big text [big]big text[/big]
## small text [small]small text[/small]
[url text](https://www.url.link) [url="https://www.url.link"]url text[/url]
![](https://image.link) [img]https://image.link[/img]
`code` [code=text]code[/code]
$$$ inline math $$$ [m]inline math[/m]
@user [user]user[/user]
#porject [project]project[/project]
--- [hr]

[lazy mode: on]
The [quote] tag is always the same, so is for the other common block level tags.
The [spoiler] tag is produced simply by putting ! after > in the first line of a quote, and if there's some text after the ! it's gonna be used as the spoiler title.
Oh, right... for the block level math tag (for multiple line equations) use $$ all the m(e|a)th you want, now with new lines support $$.

For more information and usage modes, refer to chjj/marked/README.md.

About

A markdown parser and compiler to BBCode. Built for speed (and nerdz.eu)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%