diff --git a/README.md b/README.md index 738a79b7..b206b35e 100644 --- a/README.md +++ b/README.md @@ -47,9 +47,10 @@ _We will only explain features extended in marp-core._ Please refer to [Marpit f - Enabled [inline SVG slide](https://marpit.marp.app/inline-svg) and [loose YAML parsing](https://marpit-api.marp.app/marpit#Marpit) by default. * **CommonMark** - - For making secure, we will deny most of HTML tags used in Markdown (`
` is only allowed by default). + - For making secure, we will deny most of HTML tags used in Markdown by default. Allowed HTML tags are `
` only for now. - Support [table](https://github.github.com/gfm/#tables-extension-) and [strikethrough](https://github.github.com/gfm/#strikethrough-extension-) syntax, based on [GitHub Flavored Markdown](https://github.github.com/gfm/). - Line breaks in paragraph will convert to `
` tag. + - Slugification for headings (assining auto-generated `id` attribute for `

` - `

`) is enabled by default. --- @@ -229,6 +230,7 @@ const marp = new Marp({ source: 'cdn', nonce: 'xxxxxxxxxxxxxxx', }, + slug: false, // It can be included Marpit constructor options looseYAML: false, @@ -264,7 +266,7 @@ By passing `object`, you can set the allowlist to specify allowed tags and attri } ``` -Marp core allows only `
` tag by default, that is defined in [`Marp.html`](https://github.com/marp-team/marp-core/blob/5c3593320f1c1234f3b2556ecd1ff1f91d69c77a/src/marp.ts#L45). +Marp core allows only `
` tag by default. That is defined in [a readonly `html` member in `Marp` class](https://github.com/marp-team/marp-core/blob/38fb33680c5837f9c48d8a88ac94b9f0862ab6c7/src/marp.ts#L34). > Whatever any option is selected, `` and `