michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Rename the markdownOptions "parser" property to "render" (#2030)

Browse source 
The `parser` key isn't valid, `render` needs to be used instead so just updating the docs to save anyone else a headache.
This commit is contained in:
Joshua Jackson 2021-11-30 03:12:42 +00:00 committed by GitHub
parent 4e06767c01
commit 247b6a027b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/src/pages/guides/markdown-content.md
View file

@ -14,7 +14,7 @@ Astro lets you use any Markdown parser you want. It just needs to be a function
// astro.config.mjs // astro.config.mjs
export default { export default {
markdownOptions: { markdownOptions: {
parser: [ render: [
'parser-name', // or import('parser-name') or (contents) => {...} 'parser-name', // or import('parser-name') or (contents) => {...}
{ {
// options // options
@ -47,7 +47,7 @@ If you want to add a plugin, you need to install the npm package dependency in y
// astro.config.mjs // astro.config.mjs
export default { export default {
markdownOptions: { markdownOptions: {
parser: [ render: [
'@astrojs/markdown-remark', '@astrojs/markdown-remark',
{ {
remarkPlugins: [ remarkPlugins: [
@ -73,7 +73,7 @@ You can provide names of the plugins as well as import them:
// astro.config.mjs // astro.config.mjs
export default { export default {
markdownOptions: { markdownOptions: {
parser: [ render: [
'@astrojs/markdown-remark', '@astrojs/markdown-remark',
{ {
remarkPlugins: [ remarkPlugins: [