From d4bbf000d508fe9b9ba17fb395d2a28c88012527 Mon Sep 17 00:00:00 2001 From: Noah Silvera Date: Mon, 2 Mar 2020 19:19:01 -0800 Subject: [PATCH] docs(v2): add examples to plugin usage doc (#2351) Add an example value for the remarkPlugins config option for plugin-content-blog and plugin-content docs Initially I tried to use a string value with this config and got an esoteric error. Having an example of it's usage would help. --- website/docs/using-plugins.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/using-plugins.md b/website/docs/using-plugins.md index 7bb7d4a4d2..b93c375bb8 100644 --- a/website/docs/using-plugins.md +++ b/website/docs/using-plugins.md @@ -172,7 +172,7 @@ module.exports = { /** * Remark and Rehype plugins passed to MDX */ - remarkPlugins: [], + remarkPlugins: [/* require('remark-math') */], rehypePlugins: [], /** * Truncate marker, can be a regex or string. @@ -246,7 +246,7 @@ module.exports = { /** * Remark and Rehype plugins passed to MDX */ - remarkPlugins: [], + remarkPlugins: [/* require('remark-math') */], rehypePlugins: [], /** * Whether to display the author who last updated the doc.