Skip to content

Commit

Permalink
Add info for custom markdown parser.
Browse files Browse the repository at this point in the history
  • Loading branch information
rottmann committed May 7, 2015
1 parent ad90e7b commit 986af3d
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions MARKDOWN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Markdown Parser

By default apiDoc uses [markdown-it](https://github.com/markdown-it/markdown-it) Markdown Parser.



## Custom Parser

`apidoc --markdown /path/to/a/custom_markdown_parser.js`

Your custom parser must return a class with a render-method.



## Examples

### With "markdown-it" Markdown Parser.

```js
var Markdown = require('markdown-it');

function CustomMarkdownParser() {
this.markdownParser = new Markdown({
breaks : false,
html : true,
linkify : true,
typographer: false
});
}

module.exports = CustomMarkdownParser;

CustomMarkdownParser.prototype.render = function(text) {
return this.markdownParser.render(text);
};
```



### With "marked" Markdown Parser.

**marked seemed to be outdated and has currently a security issue, please use it not anymore in production.**
This is only an demo.

```js
var markdownParser = require('marked');

function CustomMarkdownParser() {
markdownParser.setOptions({
gfm : true,
tables : true,
breaks : false,
pedantic : false,
sanitize : false,
smartLists : false,
smartypants: false
});
}

module.exports = CustomMarkdownParser;

CustomMarkdownParser.prototype.render = function(text) {
return markdownParser(text);
};
```

0 comments on commit 986af3d

Please sign in to comment.