297 Commits

Author SHA1 Message Date
FHantke
74ccecf771
chore(docs): add a secure example to the documentation. (#2462)
* Add a sanitized example

* Remove !

* move example below warning

Co-authored-by: Florian Hantke <florian.hantke@cispa.de>
2022-05-07 11:37:21 -05:00
Trevor Buckner
a784f72450
chore: clarify custom extension RegEx anchoring to string start (#2415) 2022-03-21 11:02:59 -05:00
Chell
e709bd7ff3
chore(docs): rename inconsistent function (#2316) 2021-12-09 08:39:27 -06:00
Alexander Cerutti
6ac4d82254
chore(docs): Improved CLI Examples (#2303) 2021-11-24 15:19:58 -06:00
Tony Brix
6cba7b4b12
chore(docs): remove nptable tokenizer from docs (#2293) 2021-11-18 11:35:18 -06:00
Ben McCann
4afb228d95
fix: Convert to ESM (#2227)
BREAKING CHANGE:

- Default export removed. Use `import { marked } from 'marked'` or `const { marked } = require('marked')` instead.
- `/lib/marked.js` removed. Use `/marked.min.js` in script tag instead.
- When using marked in a script tag use `marked.parse(...)` instead of `marked(...)`
2021-11-02 09:32:17 -05:00
Tony Brix
2da5885989
fix: walkTokens uses marked as this (#2251) 2021-10-24 00:03:59 -05:00
Andrew
e583f46f0d
chore(docs): Use langPrefix in highlight.js example. (#2176)
To properly integrate [highlight.js](https://github.com/highlightjs/highlight.js/) when using `marked.setOptions`, you need to leverage `langPrefix` to add an additional `hljs` class to the top-level `<code>` element which will be rendered.

Closes #2171
2021-08-23 13:51:52 -05:00
Tony Brix
9c312b2cb1
chore(docs): fix extension docs indentation (#2178) 2021-08-22 18:57:14 -05:00
Alasdair
6fa4842920
chore(docs): Add note about supported versions (#1938) 2021-08-16 09:19:44 -05:00
Trevor Buckner
288f1cbe2f
Tokenizers lex their own child tokens (#2124)
BREAKING CHANGES:

- Tokenizers will create their own tokens with `this.lexer.inline(text, tokens)`. The `inline` function will queue the token creation until after all block tokens are rendered.
- `nptable` tokenizer is removed and merged with `table` tokenizer.
- Extensions tokenizer `this` object will include the `lexer` as a property. `this.inlineTokens` becomes `this.lexer.inline`.
- Extensions parser `this` object will include the `parser` as a property. `this.parseInline` becomes `this.parser.parseInline`.
- `tag` and `inlineText` tokenizer function signatures have changed.
2021-08-02 14:12:43 -05:00
Tony Brix
22ead33a0f
chore(docs): fix async highlight example (#2123) 2021-06-30 22:42:06 -04:00
Tony Brix
da1c57f74c
chore(docs): add extensions link to nav links (#2105) 2021-06-16 09:55:06 -05:00
Trevor Buckner
5be9d6d70e
feat: Custom Tokenizer/Renderer extensions (#2043)
Co-authored-by: Tony Brix <tony@brix.ninja>
2021-06-15 18:22:00 -05:00
Steven
65c3f77f3f
docs: update highlight.js usage (#2003) 2021-04-11 22:37:55 -05:00
Tony Brix
e8ddad0971
docs: fix demo initial options not loaded (#1983) 2021-03-25 08:51:34 -05:00
Ulisse mini
29dbc21d20
docs: warn about broken inline latex example (#1949)
The docs don't mention how the latex example won't actually work with inline latex, ie. `foo $bar$ baz`
2021-02-19 10:04:41 -06:00
Tony Brix
3ad3b10fb1
docs: update inline tokenizer docs with emStrong (#1928) 2021-02-07 20:26:57 -06:00
Trevor Buckner
f848e77039
fix: Join adjacent inlineText tokens (#1926) 2021-02-07 16:22:47 -06:00
Tony Brix
a775f1b3f4
chore(demo): add links to other demos (#1852) 2020-11-30 08:47:12 -06:00
Tony Brix
803a6a960a
chore(dev-deps): remove eslint-plugin-standard (#1849) 2020-11-22 23:19:28 -06:00
Tony Brix
f17f55f9d9
chore(docs): update versioning and other docs (#1834)
Co-authored-by: Steven <steven@ceriously.com>
2020-11-18 14:20:03 -06:00
Tony Brix
c50e39e58a
chore(docs): Codeql fixes (#1793) 2020-11-06 08:34:31 -06:00
Tony Brix
3c31a3008c
chore: use semantic release (#1767) 2020-10-21 08:21:12 -05:00
Tony Brix
d0818b6367
update docs example 2020-09-21 09:59:33 -05:00
Tony Brix
957a4f3893
Update docs/INDEX.md
Co-authored-by: Steven <steven@ceriously.com>
2020-09-21 09:57:04 -05:00
Tony Brix
c38ecb435c
Update docs/INDEX.md
Co-authored-by: Steven <steven@ceriously.com>
2020-09-21 09:56:54 -05:00
Tony Brix
5afb00518f add inline markdown docs 2020-09-21 00:00:45 -05:00
Steven
cf80141f37 Missed one html suffix 2020-08-29 18:55:11 -04:00
Steven
7846b3da9b Add redirect from old URL to new URL 2020-08-29 18:46:56 -04:00
Steven
9bf1836e00 Fix logo height/width 2020-08-29 18:32:39 -04:00
Steven
0e87266b29 Optimize logo svg 2020-08-29 18:13:33 -04:00
Steven
010c95f090 Use cleanUrls 2020-08-29 17:55:07 -04:00
Steven
8a681e8523 Add a title to each page 2020-08-16 23:34:13 -04:00
Steven
b134cf6e70 Fix nav selected 2020-08-16 22:49:46 -04:00
Steven
2bf10a9eb7 Add hightlight.js styles 2020-08-16 22:41:11 -04:00
Steven
5e704a0072 Move css to separate file 2020-08-16 22:29:05 -04:00
Steven
432bb1d9eb Copy license to docs 2020-08-15 19:42:22 -04:00
Steven
6789214c5c Fix links to other documents 2020-08-15 19:35:00 -04:00
Steven
ecf9112085 Rename readme to index 2020-08-15 19:21:36 -04:00
Steven
94ab9121c1 Add template _document.html 2020-08-15 19:20:00 -04:00
Steven
b6773fca41 Delete CNAME 2020-08-13 10:35:42 -04:00
Steven
76184a9596 Marked.js => Marked 2020-08-10 10:11:14 -04:00
Steven
ba130648df
Merge pull request #1728 from flouc001/nfe/dry-run-slug
NFE: add dry run capabilities to default slugger
2020-07-15 08:46:24 -04:00
Callum
0c415fd82e
update docs example to be clearer
Co-authored-by: Steven <steven@ceriously.com>
2020-07-15 08:02:55 +01:00
Tony Brix
6f7522fce7
Merge pull request #1729 from UziTech/quick-ref 2020-07-13 13:10:08 -05:00
Tony Brix
f8024eb24d
remove ending slash
Co-authored-by: Steven <steven@ceriously.com>
2020-07-13 13:07:46 -05:00
Tony Brix
524ae66ba6
remove ending slash
Co-authored-by: Steven <steven@ceriously.com>
2020-07-13 13:07:30 -05:00
flouc001
710658cb61 use options param, update docs, update tests 2020-07-12 19:38:37 +01:00
flouc001
2290f677c9 update docs 2020-07-11 09:36:24 +01:00