summaryrefslogtreecommitdiff
path: root/docs/src/pages/guides/markdown-content.md
diff options
context:
space:
mode:
authorGravatar Maksim Markelov <maks-markel@mail.ru> 2021-07-28 19:33:19 +0300
committerGravatar GitHub <noreply@github.com> 2021-07-28 12:33:19 -0400
commit70f0a09d3041a8ee053c67651fdda15dffc17549 (patch)
tree6428abf42698b765f35b09cb9cb3581147b9ff55 /docs/src/pages/guides/markdown-content.md
parent5e3e828a4416f1a2b7fc0afe9d62182f18bf2680 (diff)
downloadastro-70f0a09d3041a8ee053c67651fdda15dffc17549.tar.gz
astro-70f0a09d3041a8ee053c67651fdda15dffc17549.tar.zst
astro-70f0a09d3041a8ee053c67651fdda15dffc17549.zip
Add remark-slug (#862)
* Add remark-slug * Add remark-slug in documentation * Add changeset
Diffstat (limited to 'docs/src/pages/guides/markdown-content.md')
-rw-r--r--docs/src/pages/guides/markdown-content.md6
1 files changed, 2 insertions, 4 deletions
diff --git a/docs/src/pages/guides/markdown-content.md b/docs/src/pages/guides/markdown-content.md
index 0717ba158..4ef908f6b 100644
--- a/docs/src/pages/guides/markdown-content.md
+++ b/docs/src/pages/guides/markdown-content.md
@@ -7,11 +7,11 @@ Astro comes with out-of-the-box Markdown support powered by the expansive [remar
## Remark and Rehype Plugins
-In addition to custom components inside the [`<Markdown>` component](/guides/markdown-content#astros-markdown-component), Astro comes with [GitHub-flavored Markdown](https://github.github.com/gfm/) support, [Footnotes](https://github.com/remarkjs/remark-footnotes) syntax, [Smartypants](https://github.com/silvenon/remark-smartypants), and syntax highlighting via [Prism](https://prismjs.com/) pre-enabled.
+In addition to custom components inside the [`<Markdown>` component](/guides/markdown-content#astros-markdown-component), Astro comes with [GitHub-flavored Markdown](https://github.github.com/gfm/) support, [Footnotes](https://github.com/remarkjs/remark-footnotes) syntax, [Smartypants](https://github.com/silvenon/remark-smartypants), [Remark-slug](https://github.com/remarkjs/remark-slug) and syntax highlighting via [Prism](https://prismjs.com/) pre-enabled.
Also, Astro supports third-party plugins for Markdown. You can provide your plugins in `astro.config.mjs`.
-> **Note:** Enabling custom `remarkPlugins` or `rehypePlugins` removes Astro's built-in support for [GitHub-flavored Markdown](https://github.github.com/gfm/) support, [Footnotes](https://github.com/remarkjs/remark-footnotes) syntax, [Smartypants](https://github.com/silvenon/remark-smartypants). You must explicitly add these plugins to your `astro.config.mjs` file, if desired.
+> **Note:** Enabling custom `remarkPlugins` or `rehypePlugins` removes Astro's built-in support for [GitHub-flavored Markdown](https://github.github.com/gfm/) support, [Footnotes](https://github.com/remarkjs/remark-footnotes) syntax, [Smartypants](https://github.com/silvenon/remark-smartypants), [Remark-slug](https://github.com/remarkjs/remark-slug). You must explicitly add these plugins to your `astro.config.mjs` file, if desired.
## Add a Markdown plugin in Astro
@@ -24,7 +24,6 @@ export default {
remarkPlugins: [
// Add a Remark plugin that you want to enable for your project.
// If you need to provide options for the plugin, you can use an array and put the options as the second item.
- // 'remark-slug',
// ['remark-autolink-headings', { behavior: 'prepend'}],
],
rehypePlugins: [
@@ -44,7 +43,6 @@ You can provide names of the plugins as well as import them:
export default {
markdownOptions: {
remarkPlugins: [
- import('remark-slug'),
[import('remark-autolink-headings'), { behavior: 'prepend' }],
],
},