Skip to content

Commit

Permalink
update docs with marked.use
Browse files Browse the repository at this point in the history
  • Loading branch information
UziTech committed Apr 19, 2020
1 parent dd86b71 commit 07510c9
Showing 1 changed file with 32 additions and 28 deletions.
60 changes: 32 additions & 28 deletions docs/USING_PRO.md
Expand Up @@ -12,24 +12,25 @@ The renderer defines the output of the parser.
// Create reference instance
const marked = require('marked');

// Get reference
const renderer = new marked.Renderer();

// Override function
renderer.heading = function(text, level) {
const escapedText = text.toLowerCase().replace(/[^\w]+/g, '-');

return `
<h${level}>
<a name="${escapedText}" class="anchor" href="#${escapedText}">
<span class="header-link"></span>
</a>
${text}
</h${level}>`;
const renderer = {
heading(text, level) {
const escapedText = text.toLowerCase().replace(/[^\w]+/g, '-');

return `
<h${level}>
<a name="${escapedText}" class="anchor" href="#${escapedText}">
<span class="header-link"></span>
</a>
${text}
</h${level}>`;
}
};

marked.use({ renderer });

// Run marked
console.log(marked('# heading+', { renderer }));
console.log(marked('# heading+'));
```

**Output:**
Expand Down Expand Up @@ -99,30 +100,33 @@ The tokenizer defines how to turn markdown text into tokens.
// Create reference instance
const marked = require('marked');

// Get reference
const tokenizer = new marked.Tokenizer();
const originalCodespan = tokenizer.codespan;
// Override function
tokenizer.codespan = function(src) {
const match = src.match(/\$+([^\$\n]+?)\$+/);
if (match) {
return {
type: 'codespan',
raw: match[0],
text: match[1].trim()
};
const tokenizer = {
codespan(src) {
const match = src.match(/\$+([^\$\n]+?)\$+/);
if (match) {
return {
type: 'codespan',
raw: match[0],
text: match[1].trim()
};
}
const originalTokenizer = new marked.Tokenizer(this.options);
return originalTokenizer.codespan.apply(this, arguments);
}
return originalCodespan.apply(this, arguments);
};

marked.use({ tokenizer });

// Run marked
console.log(marked('$ latex code $', { tokenizer }));
console.log(marked('$ latex code $\n\n` other code `'));
```

**Output:**

```html
<p><code>latext code</code></p>
<p><code>latex code</code></p>
<p><code>other code</code></p>
```

### Block level tokenizer methods
Expand Down

0 comments on commit 07510c9

Please sign in to comment.