mirror of https://github.com/markedjs/marked
Use cleanUrls
Steven
parent
8a681e8523
commit
010c95f090
|
|
@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
|
|||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team by submitting a PR with changes to the [AUTHORS](/authors.html) page (or emailing josh@8fold.com). All
|
||||
reported by contacting the project team by submitting a PR with changes to the [AUTHORS](/authors) page (or emailing josh@8fold.com). All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ $ marked -s "*hello world*"
|
|||
```
|
||||
|
||||
|
||||
Marked offers [advanced configurations](/using_advanced.html) and [extensibility](/using_pro.html) as well.
|
||||
Marked offers [advanced configurations](/using_advanced) and [extensibility](/using_pro) as well.
|
||||
|
||||
<h2 id="specifications">Supported Markdown specifications</h2>
|
||||
|
||||
|
|
@ -81,5 +81,5 @@ By supporting the above Markdown flavors, it's possible that Marked can help you
|
|||
|
||||
The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously.
|
||||
|
||||
Therefore, please disclose potential security issues by email to the project [committers](/authors.html) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue).
|
||||
Therefore, please disclose potential security issues by email to the project [committers](/authors) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Releasing Marked
|
||||
|
||||
- [ ] See [contributing](/contributing.html)
|
||||
- [ ] See [contributing](/contributing)
|
||||
- [ ] Create release branch from `master` (`release-x.y.z`)
|
||||
- [ ] Submit PR with minimal name: Release x.y.z
|
||||
- [ ] Complete PR checklists
|
||||
|
|
|
|||
|
|
@ -51,14 +51,14 @@ console.log(marked(markdownString));
|
|||
|langPrefix |`string` |`'language-'`|v0.3.0|A string to prefix the className in a `<code>` block. Useful for syntax highlighting.|
|
||||
|mangle |`boolean` |`true` |v0.3.4 |If true, autolinked email address is escaped with HTML character references.|
|
||||
|pedantic |`boolean` |`false` |v0.2.1 |If true, conform to the original `markdown.pl` as much as possible. Don't fix original markdown bugs or behavior. Turns off and overrides `gfm`.|
|
||||
|renderer |`object` |`new Renderer()`|v0.3.0|An object containing functions to render tokens to HTML. See [extensibility](/using_pro.html) for more details.|
|
||||
|renderer |`object` |`new Renderer()`|v0.3.0|An object containing functions to render tokens to HTML. See [extensibility](/using_pro) for more details.|
|
||||
|sanitize |`boolean` |`false` |v0.2.1 |If true, sanitize the HTML passed into `markdownString` with the `sanitizer` function.<br>**Warning**: This feature is deprecated and it should NOT be used as it cannot be considered secure.<br>Instead use a sanitize library, like [DOMPurify](https://github.com/cure53/DOMPurify) (recommended), [sanitize-html](https://github.com/apostrophecms/sanitize-html) or [insane](https://github.com/bevacqua/insane) on the output HTML! |
|
||||
|sanitizer |`function`|`null` |v0.3.4 |A function to sanitize the HTML passed into `markdownString`.|
|
||||
|silent |`boolean` |`false` |v0.2.7 |If true, the parser does not throw any exception.|
|
||||
|smartLists |`boolean` |`false` |v0.2.8 |If true, use smarter list behavior than those found in `markdown.pl`.|
|
||||
|smartypants |`boolean` |`false` |v0.2.9 |If true, use "smart" typographic punctuation for things like quotes and dashes.|
|
||||
|tokenizer |`object` |`new Tokenizer()`|v1.0.0|An object containing functions to create tokens from markdown. See [extensibility](/using_pro.html) for more details.|
|
||||
|walkTokens |`function` |`null`|v1.1.0|A function which is called for every token. See [extensibility](/using_pro.html) for more details.|
|
||||
|tokenizer |`object` |`new Tokenizer()`|v1.0.0|An object containing functions to create tokens from markdown. See [extensibility](/using_pro) for more details.|
|
||||
|walkTokens |`function` |`null`|v1.1.0|A function which is called for every token. See [extensibility](/using_pro) for more details.|
|
||||
|xhtml |`boolean` |`false` |v0.3.2 |If true, emit self-closing HTML tags for void elements (<br/>, <img/>, etc.) with a "/" as required by XHTML.|
|
||||
|
||||
<h2 id="highlight">Asynchronous highlighting</h2>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ To champion the single-responsibility and open/closed principles, we have tried
|
|||
|
||||
<h2 id="use">marked.use()</h2>
|
||||
|
||||
`marked.use(options)` is the recommended way to extend marked. The options object can contain any [option](/using_advanced.html#options) available in marked.
|
||||
`marked.use(options)` is the recommended way to extend marked. The options object can contain any [option](/using_advanced#options) available in marked.
|
||||
|
||||
The `renderer` and `tokenizer` options can be an object with functions that will be merged into the `renderer` and `tokenizer` respectively.
|
||||
|
||||
|
|
|
|||
|
|
@ -35,36 +35,36 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/using_advanced.html">Advanced Usage</a>
|
||||
<a href="/using_advanced">Advanced Usage</a>
|
||||
<ul>
|
||||
<li><a href="/using_advanced.html#options">Options</a></li>
|
||||
<li><a href="/using_advanced.html#highlight">Highlighting</a></li>
|
||||
<li><a href="/using_advanced.html#workers">Workers</a></li>
|
||||
<li><a href="/using_advanced#options">Options</a></li>
|
||||
<li><a href="/using_advanced#highlight">Highlighting</a></li>
|
||||
<li><a href="/using_advanced#workers">Workers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/using_pro.html">Extensibility</a>
|
||||
<a href="/using_pro">Extensibility</a>
|
||||
<ul>
|
||||
<li><a href="/using_pro.html#use">marked.use()</a></li>
|
||||
<li><a href="/using_pro.html#renderer">Renderer</a></li>
|
||||
<li><a href="/using_pro.html#tokenizer">Tokenizer</a></li>
|
||||
<li><a href="/using_pro.html#walk-tokens">Walk Tokens</a></li>
|
||||
<li><a href="/using_pro.html#lexer">Lexer</a></li>
|
||||
<li><a href="/using_pro.html#parser">Parser</a></li>
|
||||
<li><a href="/using_pro#use">marked.use()</a></li>
|
||||
<li><a href="/using_pro#renderer">Renderer</a></li>
|
||||
<li><a href="/using_pro#tokenizer">Tokenizer</a></li>
|
||||
<li><a href="/using_pro#walk-tokens">Walk Tokens</a></li>
|
||||
<li><a href="/using_pro#lexer">Lexer</a></li>
|
||||
<li><a href="/using_pro#parser">Parser</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/contributing.html">Contributing</a>
|
||||
<a href="/contributing">Contributing</a>
|
||||
<ul>
|
||||
<li><a href="/contributing.html#design-principles">Design Principles</a></li>
|
||||
<li><a href="/contributing.html#priorities">Priorities</a></li>
|
||||
<li><a href="/contributing.html#test-early-often-and-everything">Testing</a></li>
|
||||
<li><a href="/contributing#design-principles">Design Principles</a></li>
|
||||
<li><a href="/contributing#priorities">Priorities</a></li>
|
||||
<li><a href="/contributing#test-early-often-and-everything">Testing</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="/code_of_conduct.html">Code of Conduct</a></li>
|
||||
<li><a href="/authors.html">Authors</a></li>
|
||||
<li><a href="/publishing.html">Publishing</a></li>
|
||||
<li><a href="/license.html">License</a></li>
|
||||
<li><a href="/code_of_conduct">Code of Conduct</a></li>
|
||||
<li><a href="/authors">Authors</a></li>
|
||||
<li><a href="/publishing">Publishing</a></li>
|
||||
<li><a href="/license">License</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<div id="content"><!--{{content}}--></div>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"cleanUrls": true
|
||||
}
|
||||
Loading…
Reference in New Issue