md2bbc

v1.1.0

Published

2 years ago

Renderer for marked to convert markdown to bbcode

Downloads

0High
0Medium
0Low

holi0317

markdown bbcode

md2bbc.js

Markdown is cool. But forums only support bbcode.

Is there a way to use markdown in forum?

With this question, this tool is developed.

Plugin for marked that convert markdown to bbcode.

To Users

Hey! I am online and ready to use. Check the deployed version here.

Install

npm install --save md2bbc marked if you are using node.js or browserify, or;

bower install --save md2bbc marked if you want to use this in browser.

This support node.js require, browserify, AMD(though I don't know how to use it) and <script>

Usage

Node.js/browserify:

let marked = require('marked');
let md2bbc = require('md2bbc');

console.log(marked('**Markdown** is awesome.', {
  renderer: new md2bbc()
}));

// Or, set default renderer to md2bbc
marked.setOptions({
  renderer: new md2bbc()
});
console.log(marked('**Markdown** is awesome.'));

// Both will log [div][b]Markdown[/b] is awesome.[/div]

Browser:

<!doctype html>
<html>
<head>
  <title>Marked in the browser</title>
  <script src="bower_components/marked/dist/marked.js"></script>
  <script src="bower_components/md2bbc/dist/md2bbc.min.js"></script>
</head>
<body>
  <script>
  marked.setOptions({
    renderer: new md2bbc()
  });
  console.log(marked('**Markdown** is awesome.'));
  </script>
</body>
</html>

Options

Type: Object

Reminder: Do not set option in md2bbc constructor. Instead, set them in marked option.

I.E.

let marked = require('marked');
let md2bbc = require('md2bbc');

marked.setOptions({
  renderer: new md2bbc(),
  paragraphTag: 'div',
  tableAttr: 'width=98% broder=1'
})

Warning: Options does not perform type check. Make sure you have passed in correct type.

Options contains the following keys:

paragraphTag

Type: String

Default: div

The tag name for paragraph tag.

If '' is passed in, no tag will be inserted for paragraph

tableAttr

Type String

Default: ''

Attribute for table. For example, width and broder of the table, if your implementation of BBcode is supported.

If '' is passed in, no attribute will be added.

Do not add space before it.

tableAlign

Type: Boolean

Default: true

Enable align for table(or table cell, if you like)

Overriding

You may override any function you want by doing the followings:

let marked = require('marked');
let md2bbc = require('md2bbc');

// Create a new instance of md2bbc renderer
let renderer = new md2bbc();

// Override html rendering
renderer.html = html => {
  return ''
};

marked.setOptions({
  renderer: renderer
});

(Methods can be found from here)

Reminder

Not all bbcode implementation got all features. For example, some does not have code tag. Please either ask forum master to implement that as this is somewhat a bug form their side. I write this base on the implementation of gamer.com.tw(Chinese site).

Running tests on node.js

Clone this repository
Run npm install
Run npm test

Build it

Building this will minify the javascript and create a sourcemap for it.

Install gulp globally by npm install -g gulp
Run npm install
Run gulp
Built javascript will be in dist/