Skip to content

Commit 97f4cb5

Browse files
committed
Docs: Prefer ec.config.mjs for plugin config and styling examples
1 parent e14162e commit 97f4cb5

4 files changed

Lines changed: 8 additions & 0 deletions

File tree

docs/scripts/typedoc/templates/plugins/collapsible-sections.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ The plugin supports different section styles, which can be set per block using t
8282
You can also change the prop's default value globally to avoid having to specify it for each code block. To do so, add it to the [`defaultProps`](/reference/configuration/#defaultprops) configuration option:
8383

8484
<ConfigVariants
85+
preferEcConfigFile
8586
imports={`
8687
import { pluginCollapsibleSections } from '@expressive-code/plugin-collapsible-sections' // no-ins
8788
`}
@@ -139,6 +140,7 @@ editSections:
139140
This plugin adds a `collapsibleSections` object to the `styleOverrides` engine config option, allowing you to customize the visual appearance of the sections:
140141

141142
<ConfigVariants
143+
preferEcConfigFile
142144
imports={`
143145
import { pluginCollapsibleSections } from '@expressive-code/plugin-collapsible-sections' // no-ins
144146
`}

docs/scripts/typedoc/templates/plugins/line-numbers.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ After installing the plugin, line numbers will be displayed in the gutter of all
117117
You can configure this default behavior using the `defaultProps` option in your Expressive Code configuration. You can also change the defaults by language using the sub-property `overridesByLang`:
118118

119119
<ConfigVariants
120+
preferEcConfigFile
120121
imports={`
121122
import { pluginLineNumbers } from '@expressive-code/plugin-line-numbers' // no-ins
122123
`}
@@ -140,6 +141,7 @@ You can configure this default behavior using the `defaultProps` option in your
140141
This plugin adds a `lineNumbers` object to the `styleOverrides` engine config option, allowing you to customize the visual appearance of the line numbers:
141142

142143
<ConfigVariants
144+
preferEcConfigFile
143145
imports={`
144146
import { pluginLineNumbers } from '@expressive-code/plugin-line-numbers' // no-ins
145147
`}

docs/src/content/docs/plugins/collapsible-sections.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ The plugin supports different section styles, which can be set per block using t
8686
You can also change the prop's default value globally to avoid having to specify it for each code block. To do so, add it to the [`defaultProps`](/reference/configuration/#defaultprops) configuration option:
8787

8888
<ConfigVariants
89+
preferEcConfigFile
8990
imports={`
9091
import { pluginCollapsibleSections } from '@expressive-code/plugin-collapsible-sections' // no-ins
9192
`}
@@ -166,6 +167,7 @@ Allows to select one of the following collapsible section styles:
166167
This plugin adds a `collapsibleSections` object to the `styleOverrides` engine config option, allowing you to customize the visual appearance of the sections:
167168

168169
<ConfigVariants
170+
preferEcConfigFile
169171
imports={`
170172
import { pluginCollapsibleSections } from '@expressive-code/plugin-collapsible-sections' // no-ins
171173
`}

docs/src/content/docs/plugins/line-numbers.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ After installing the plugin, line numbers will be displayed in the gutter of all
132132
You can configure this default behavior using the `defaultProps` option in your Expressive Code configuration. You can also change the defaults by language using the sub-property `overridesByLang`:
133133

134134
<ConfigVariants
135+
preferEcConfigFile
135136
imports={`
136137
import { pluginLineNumbers } from '@expressive-code/plugin-line-numbers' // no-ins
137138
`}
@@ -155,6 +156,7 @@ You can configure this default behavior using the `defaultProps` option in your
155156
This plugin adds a `lineNumbers` object to the `styleOverrides` engine config option, allowing you to customize the visual appearance of the line numbers:
156157

157158
<ConfigVariants
159+
preferEcConfigFile
158160
imports={`
159161
import { pluginLineNumbers } from '@expressive-code/plugin-line-numbers' // no-ins
160162
`}

0 commit comments

Comments
 (0)