-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Mobiledoc DOM Renderer | ||
|
||
This is a runtime renderer for the `mobiledoc` format. | ||
It renders mobiledoc to DOM elements. | ||
|
||
It is intended to be a small libraray that is run client-side in a browser that wants to display mobiledoc. | ||
|
||
## Usage | ||
|
||
``` | ||
var mobiledoc = [ | ||
[ // markers | ||
['B'] | ||
], | ||
[ // sections | ||
[1, 'P', [ // array of markups | ||
// markup | ||
[ | ||
[0], // open markers (by index) | ||
0, // close count | ||
'hello world' | ||
] | ||
] | ||
] | ||
]; | ||
var renderer = new DOMRenderer(); | ||
var rendered = renderer.render(mobiledoc); | ||
document.getElementById('output').appendChild(rendered); | ||
// renders <div><p><b>hello world</b></b></div> | ||
// into 'output' element | ||
``` | ||
|
||
## Tests | ||
|
||
* `npm test` |