diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index 8a90f320..af1b2430 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -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. diff --git a/docs/INDEX.md b/docs/INDEX.md index 12d3caab..b29731d8 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -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.

Supported Markdown specifications

@@ -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). diff --git a/docs/PUBLISHING.md b/docs/PUBLISHING.md index 8d88b0c6..57907d12 100644 --- a/docs/PUBLISHING.md +++ b/docs/PUBLISHING.md @@ -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 diff --git a/docs/USING_ADVANCED.md b/docs/USING_ADVANCED.md index 42670308..58c9745e 100644 --- a/docs/USING_ADVANCED.md +++ b/docs/USING_ADVANCED.md @@ -51,14 +51,14 @@ console.log(marked(markdownString)); |langPrefix |`string` |`'language-'`|v0.3.0|A string to prefix the className in a `` 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.
**Warning**: This feature is deprecated and it should NOT be used as it cannot be considered secure.
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.|

Asynchronous highlighting

diff --git a/docs/USING_PRO.md b/docs/USING_PRO.md index 9adfd81d..b8fc872c 100644 --- a/docs/USING_PRO.md +++ b/docs/USING_PRO.md @@ -4,7 +4,7 @@ To champion the single-responsibility and open/closed principles, we have tried

marked.use()

-`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. diff --git a/docs/_document.html b/docs/_document.html index 9011df54..7cbf386e 100644 --- a/docs/_document.html +++ b/docs/_document.html @@ -35,36 +35,36 @@
  • - Advanced Usage + Advanced Usage
  • - Extensibility + Extensibility
  • - Contributing + Contributing
    • -
  • Code of Conduct
    • -
  • Authors
    • -
  • Publishing
    • -
  • License
    • +
  • Code of Conduct
    • +
  • Authors
    • +
  • Publishing
    • +
  • License
    • diff --git a/vercel.json b/vercel.json new file mode 100644 index 00000000..bd6fd8fa --- /dev/null +++ b/vercel.json @@ -0,0 +1,3 @@ +{ + "cleanUrls": true +}