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

docs: update config example in README

Browse source
This commit is contained in:
bholmesdev 2023-03-06 14:01:07 -05:00
parent 4acb7491c9
commit 28f09599ed
1 changed files with 16 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
packages/integrations/markdoc/README.md
View file

@ -99,9 +99,9 @@ Once the Markdoc integration is installed, no configuration is necessary to use
### Markdoc config
The Markdoc integration accepts [all Markdoc configuration options](https://markdoc.dev/docs/config), including [tags](https://markdoc.dev/docs/tags) and [variables](https://markdoc.dev/docs/variables).
The Markdoc integration accepts [all Markdoc configuration options](https://markdoc.dev/docs/config), including [tags](https://markdoc.dev/docs/tags) and [functions](https://markdoc.dev/docs/functions).
You can pass these options from the `markdoc()` integration in your `astro.config`. This example declares a `countries` variable and an `includes` function for use across all Markdoc content collection entries:
You can pass these options from the `markdoc()` integration in your `astro.config`. This example adds a global `getCountryEmoji` function:
```js
// astro.config.mjs
@ -112,18 +112,16 @@ import markdoc from '@astrojs/markdoc';
export default defineConfig({
integrations: [
markdoc({
variables: {
// Declare a global list of countries
// Usage in Markdoc: `$countries`
countries: ['EN', 'ES', 'JP'],
},
functions: {
// Check if array includes value
// Usage in Markdoc: `includes(arr, value)`
includes: {
getCountryEmoji: {
transform(parameters) {
const [array, value] = Object.values(parameters);
return array.includes(value);
const [country] = Object.values(parameters);
const countryToEmojiMap = {
japan: '🇯🇵',
spain: '🇪🇸',
france: '🇫🇷',
}
return countryToEmojiMap[country] ?? '🏳'
},
},
},
@ -132,6 +130,12 @@ export default defineConfig({
});
```
Now, you can call this function from any Markdoc content entry:
```md
¡Hola {% getCountryEmoji("spain") %}!
```
:::note
These options will be applied during [the Markdoc "transform" phase](https://markdoc.dev/docs/render#transform). This is run **at build time** (rather than server request time) both for static and SSR Astro projects.
:::