diff --git a/src/content/docs/fr/config-reference/dashboard.mdx b/src/content/docs/fr/config-reference/dashboard.mdx deleted file mode 100644 index f437a97b..00000000 --- a/src/content/docs/fr/config-reference/dashboard.mdx +++ /dev/null @@ -1,227 +0,0 @@ ---- -i18nReady: true -title: Configuration du tableau de bord -description: Page de référence pour les options de configuration du tableau de bord de StudioCMS -sidebar: - order: 6 ---- - -import ReadMore from '~/components/ReadMore.astro'; - -Référence du schéma des options de configuration de l’intégration StudioCMS - -```ts twoslash title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dashboardConfig: { - dashboardEnabled: true, - dashboardRouteOverride: 'dashboard', - developerConfig: {}, - faviconURL: '/favicon.svg', - inject404Route: true, - versionCheck: true, - AuthConfig: {}, - }, -}); -``` - -## `dashboardEnabled` - -`dashboardEnabled` est un booléen utilisé pour déterminer si le tableau de bord est activé. - -- **Type :** `boolean` -- **Par défaut :** `true` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dashboardConfig: { - dashboardEnabled: true, // PAR DÉFAUT - Ceci active le tableau de bord. - } -}) -``` - -## `DashboardRouteOverride` - -`DashboardRouteOverride` est une chaîne de caractères utilisée pour déterminer la route du tableau de bord. - -- **Type :** `string` -- **Par défaut :** `'dashboard'` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dashboardConfig: { - dashboardRouteOverride: 'dashboard', // PAR DÉFAUT - Ceci définit la route du tableau de bord sur /dashboard. - } -}) -``` - -## `developerConfig` - -`developerConfig` est un objet utilisé pour configurer les paramètres du développeur pour le tableau de bord. - -### Utilisation - -```ts twoslash {3-5} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dashboardConfig: { - developerConfig: { - demoMode: false, // PAR DÉFAUT - Ceci désactive le mode démo. - }, - } -}) -``` - -## `faviconURL` - -`faviconURL` est une chaîne de caractères utilisée pour déterminer le chemin vers le favicon du tableau de bord. - -- **Type :** `string` -- **Par défaut :** `'/favicon.svg'` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dashboardConfig: { - faviconURL: '/favicon.svg', // PAR DÉFAUT - Ceci définit le favicon du tableau de bord. - } -}) -``` - -## `inject404Route` - -`inject404Route` est un booléen utilisé pour déterminer si la route 404 doit être injectée. - -- **Type :** `boolean` -- **Par défaut :** `true` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dashboardConfig: { - inject404Route: true, // PAR DÉFAUT - Ceci injecte la route 404. - } -}) -``` - -## `versionCheck` - -`versionCheck` est un booléen utilisé pour déterminer si la vérification des versions doit être activée. - -- **Type :** `boolean` -- **Par défaut :** `true` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dashboardConfig: { - versionCheck: true, // PAR DÉFAUT - Ceci active la vérification des versions. - } -}) -``` - -## `AuthConfig` - -`AuthConfig` est un objet utilisé pour configurer les paramètres d’authentification du tableau de bord. - -### Utilisation - -```ts twoslash {3-5} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dashboardConfig: { - AuthConfig: { - enabled: true, // PAR DÉFAUT - Ceci active l’authentification. - }, - } -}) -``` - -### `providers` - -`providers` est un objet utilisé pour configurer les fournisseurs d’authentification pour le tableau de bord. - -- **Type :** [`AuthProviders`](#authprovider) -- **Par défaut :** `{}` - -#### Utilisation - -```ts twoslash {4-11} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dashboardConfig: { - AuthConfig: { - providers: { - google: true, - github: true, - discord: true, - auth0: true, - usernameAndPassword: true, - usernameAndPasswordConfig: {}, - }, - }, - }, -}) -``` - -#### `usernameAndPasswordConfig` - -`usernameAndPasswordConfig` est un objet utilisé pour configurer les paramètres de nom d’utilisateur et de mot de passe pour le tableau de bord. - -- **Type :** `{ allowUserRegistration?: boolean }` -- **Par défaut :** `{}` - -##### Utilisation - -```ts twoslash {5-8} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dashboardConfig: { - AuthConfig: { - providers: { - usernameAndPassword: true, - usernameAndPasswordConfig: { - allowUserRegistration: true, // PAR DÉFAUT - Ceci permet l’enregistrement de l’utilisateur. - }, - }, - }, - }, -}) -``` - -###### `AuthProvider` - -```ts -type AuthProviders: { - github?: boolean | undefined; - discord?: boolean | undefined; - google?: boolean | undefined; - auth0?: boolean | undefined; - usernameAndPassword?: boolean | undefined; - usernameAndPasswordConfig?: { - allowUserRegistration?: boolean | undefined; - } | undefined; -} | undefined -``` diff --git a/src/content/docs/fr/config-reference/default-frontend-config.mdx b/src/content/docs/fr/config-reference/default-frontend-config.mdx deleted file mode 100644 index d7d6995b..00000000 --- a/src/content/docs/fr/config-reference/default-frontend-config.mdx +++ /dev/null @@ -1,120 +0,0 @@ ---- -i18nReady: true -title: Configuration du front-end par défaut -description: Page de référence pour les options de configuration du front-end par défaut de StudioCMS -sidebar: - order: 5 ---- - -import ReadMore from '~/components/ReadMore.astro'; - -Référence du schéma des options de configuration de l’intégration StudioCMS - -```ts twoslash title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - defaultFrontEndConfig: { - favicon: '/favicon.svg', - htmlDefaultLanguage: 'en', - htmlDefaultHead: [], - injectQuickActionsMenu: true, - }, -}); -``` - -## `favicon` - -`favicon` est une chaîne de caractère utilisée pour déterminer le chemin vers le favicon du site. - -- **Type :** `string` -- **Par défaut :** `'/favicon.svg'` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - defaultFrontEndConfig: { - favicon: '/favicon.svg', // PAR DÉFAUT - Ceci utilise le favicon par défaut. - } -}) -``` - -## `htmlDefaultLanguage` - -`htmlDefaultLanguage` est une chaîne de caractère utilisée pour déterminer la langue par défaut du site. - -- **Type :** `string` -- **Par défaut :** `'en'` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - defaultFrontEndConfig: { - htmlDefaultLanguage: 'en', // PAR DÉFAUT - Ceci utilise la langue par défaut. - } -}) -``` - -## `htmlDefaultHead` - -**Type :** [`HeadConfig[]`](#headconfig) - -Ajoutez des balises personnalisées au `` de votre site Starlight. -Peut être utile pour ajouter le suivi analytique et d’autres scripts et ressources tiers. - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - defaultFrontEndConfig: { - htmlDefaultHead: [ - // Exemple : ajouter une balise de script Fathom Analytics. - { - tag: 'script', - attrs: { - src: 'https://cdn.usefathom.com/script.js', - 'data-site': 'MON-ID-FATHOM', - defer: true, - }, - }, - ], - }, -}); -``` - -Les entrées dans `head` sont converties directement en éléments HTML et ne sont pas affectés par le traitement des [scripts](https://docs.astro.build/fr/guides/client-side-scripts/#traitement-des-scripts) ou des [styles](https://docs.astro.build/fr/guides/styling/#mettre-en-forme-avec-astro) d’Astro. - -#### `HeadConfig` - -```ts -interface HeadConfig { - tag: string; - attrs?: Record; - content?: string; -} -``` - -## `injectQuickActionsMenu` - -**Type :** `boolean` -**Par défaut :** `true` - -Injecte une interface utilisateur pour des actions rapides dans le coin inférieur droit du site principal, permettant aux utilisateurs de naviguer rapidement vers l’interface d’administration de StudioCMS. - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - defaultFrontEndConfig: { - injectQuickActionsMenu: true, // PAR DÉFAUT - Ceci injecte le menu d’actions rapides. - } -}) -``` diff --git a/src/content/docs/fr/config-reference/features.mdx b/src/content/docs/fr/config-reference/features.mdx new file mode 100644 index 00000000..1a8d400b --- /dev/null +++ b/src/content/docs/fr/config-reference/features.mdx @@ -0,0 +1,449 @@ +--- +i18nReady: true +title: Fonctionnalités +description: Page de référence pour les fonctionnalités de StudioCMS +sidebar: + order: 3 + badge: + text: Mis à jour + variant: success +tableOfContents: + minHeadingLevel: 2 + maxHeadingLevel: 5 +--- + +Référence du schéma des options de configuration de l'intégration StudioCMS + +```ts twoslash title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: {}, +}); +``` + +## `robotsTXT` + +`robotsTXT` permet à l'utilisateur d'activer/de désactiver et de configurer l'utilisation de l'intégration personnalisée `astro-robots-txt` de StudioCMS + +- **Type :** `RobotsConfig` | `boolean` +- **Par défaut :** `{ policy: [ { userAgent: ['*'], allow: ['/'], disallow: ['/dashboard/'] } ] }` + +### Utilisation + +Remarque : `robotsTXT` peut également être défini sur `false` pour le désactiver. + +```ts twoslash {3-11} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + robotsTXT: { + policy: [ + { + userAgent: ['*'], + allow: ['/'], + disallow: ['/dashboard/'], + } + ] + } + } +}) +``` + +## `injectQuickActionsMenu` + +`injectQuickActionsMenu` permet d'activer et de désactiver le menu d'actions rapides qui permet un accès facile à votre tableau de bord lorsque vous êtes connecté sur des pages autres que le tableau de bord. + +- **Type :** `boolean` +- **Par défaut :** `true` + +### Utilisation + +```ts twoslash {3} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + injectQuickActionsMenu: true + } +}) +``` + +## `sdk` + +`sdk` peut être soit un booléen, soit un objet contenant la configuration du cache. S'il s'agit d'un booléen, sa valeur par défaut est `true` et le transforme en objet avec la configuration du cache par défaut. + +### Utilisation + +```ts twoslash {3} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + sdk: {} + } +}) +``` + +### `cacheConfig` + +`cacheConfig` est un objet utilisé pour configurer le cache du SDK. + +- **Type :** `boolean` | `{ lifetime?: string | undefined; }` | `undefined` +- **Par défaut :** `{ lifetime: '5m' }` + +#### Utilisation + +```ts twoslash {5-7} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + sdk: { + // PAR DÉFAUT - Ceci utilise la configuration de cache par défaut. + cacheConfig: { + lifetime: '5m', + }, + } + } +}) +``` + +## `pageTypeOptions` + +`pageTypeOptions` permet de modifier les options de type de page par défaut utilisées par StudioCMS + +### Utilisation + +```ts twoslash {3} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + pageTypeOptions: {} + } +}) +``` + +### `markdown` + +Options de configuration du moteur de rendu Markdown intégré + +#### Utilisation + +Lorsque vous travaillez avec la version standard `studiocms` de Markdown + +```ts twoslash {4-19} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + pageTypeOptions: { + markdown: { + flavor: 'studiocms', + callouts: 'obsidian', + autoLinkHeadings: true, + discordSubtext: true, + sanitize: { + allowElements: [], + blockElements: [], + dropElements: [], + allowAttributes: {}, + dropAttributes: {}, + allowComponents: false, + allowCustomElements: false, + allowComments: false, + } + } + } + } +}) +``` + +Lorsque vous travaillez avec la version `astro` de Markdown + +```ts twoslash {4-16} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + pageTypeOptions: { + markdown: { + flavor: 'astro', + sanitize: { + allowElements: [], + blockElements: [], + dropElements: [], + allowAttributes: {}, + dropAttributes: {}, + allowComponents: false, + allowCustomElements: false, + allowComments: false, + } + } + } + } +}) +``` + +### `html` + +Options de configuration du moteur de rendu HTML intégré + +#### Utilisation + +```ts twoslash {4-15} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + pageTypeOptions: { + html: { + sanitize: { + allowElements: [], + blockElements: [], + dropElements: [], + allowAttributes: {}, + dropAttributes: {}, + allowComponents: false, + allowCustomElements: false, + allowComments: false, + } + } + } + } +}) +``` + +## `dashboardConfig` + +`dashboardConfig` permet la personnalisation de la configuration du tableau de bord + +### Utilisation + +```ts twoslash {3} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + dashboardConfig: {} + } +}) +``` + +### `dashboardEnabled` + +`dashboardEnabled` permet à l'utilisateur d'activer ou de désactiver le tableau de bord de StudioCMS tout en fournissant toutes les aides et utilitaires à ceux qui personnalisent leur configuration. Cela désactivera le tableau de bord et vous devrez gérer votre contenu via votre base de données + +#### Utilisation + +```ts twoslash {4} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + dashboardConfig: { + dashboardEnabled: true, + } + } +}) +``` + +### `inject404Route` + +`inject404Route` permet à l'utilisateur d'activer ou de désactiver la route 404 par défaut pour le tableau de bord + +#### Utilisation + +```ts twoslash {4} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + dashboardConfig: { + inject404Route: true, + } + } +}) +``` + +### `faviconURL` + +`faviconURL` permet à l'utilisateur de remplacer l'URL du favicon par défaut par une URL personnalisée + +#### Utilisation + +```ts twoslash {4} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + dashboardConfig: { + faviconURL: '/favicon.svg', + } + } +}) +``` + +### `dashboardRouteOverride` + +`dashboardRouteOverride` permet à l'utilisateur de modifier la route de base sur laquelle le tableau de bord est diffusé (par exemple, `/admin` au lieu de `/dashboard`) + +#### Utilisation + +```ts twoslash {4} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + dashboardConfig: { + dashboardRouteOverride: 'dashboard', + } + } +}) +``` + +### `versionCheck` + +`versionCheck` permet à l'utilisateur d'activer ou de désactiver la vérification de version du tableau de bord. + +Cela vérifiera la dernière version de StudioCMS et avertira l'utilisateur si une nouvelle version est disponible. + +#### Utilisation + +```ts twoslash {4} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + dashboardConfig: { + versionCheck: true, + } + } +}) +``` + +## `authConfig` + +`authConfig` permet la personnalisation de la configuration d'authentification + +### Utilisation + +```ts twoslash {3} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + authConfig: {} + } +}) +``` + +### `enabled` + +Permet d'activer ou de désactiver la configuration d'authentification + +- **Type :** `boolean` +- **Par défaut :** `true` + +#### Utilisation + +```ts twoslash {4} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + authConfig: { + enabled: true + } + } +}) +``` + +### `providers` + +Permet d'activer ou de désactiver les fournisseurs d'authentification + +Les fournisseurs suivants peuvent être configurés à partir d'ici : `github`, `discord`, `google`, `auth0` et `usernameAndPassword`. + +#### Utilisation + +```ts twoslash {4-13} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + authConfig: { + providers: { + github: false, + discord: false, + google: false, + auth0: false, + usernameAndPassword: true, + usernameAndPasswordConfig: { + allowUserRegistration: true + } + } + } + } +}) +``` + +## `developerConfig` + +`developerConfig` permet la personnalisation des options du développeur + +### Utilisation + +```ts twoslash {3} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + developerConfig: {} + } +}) +``` + +### `demoMode` + +Active le mode démo pour le site. Si ce paramètre est défini sur un objet, le site sera en mode démo et l'utilisateur pourra se connecter avec le nom d'utilisateur et le mot de passe fournis. + +#### Utilisation + +```ts twoslash {4-7} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + developerConfig: { + demoMode: { + username: 'foo', + password: 'bar' + } + } + } +}) +``` + +## `preferredImageService` + +`preferredImageService` permet de définir l'identifiant du service d'images préféré + +Nécessite l'installation d'un service d'image tel que `cloudinary-js` + +- **Type :** `string` | `undefined` +- **Par défaut :** `undefined` + +### Utilisation + +```ts twoslash {3} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + features: { + preferredImageService: undefined + } +}) +``` diff --git a/src/content/docs/fr/config-reference/image-service.mdx b/src/content/docs/fr/config-reference/image-service.mdx deleted file mode 100644 index 29ca7e0d..00000000 --- a/src/content/docs/fr/config-reference/image-service.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -i18nReady: true -title: Service d'images -description: Page de référence pour les options du service d’images de StudioCMS -sidebar: - order: 4 ---- - -import ReadMore from '~/components/ReadMore.astro'; - -Référence du schéma des options de configuration de l’intégration StudioCMS - -```ts twoslash title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - imageService: { - cdnPlugin: 'cloudinary-js' - }, -}); -``` - -## `cdnPlugin` - -`cdnPlugin` est une énumération utilisée pour déterminer quel module d’extension CDN utiliser pour les images, s’il est activé. - -- **Type :** `'cloudinary-js'` | `undefined` -- **Par défaut :** `undefined` diff --git a/src/content/docs/fr/config-reference/included-integrations.mdx b/src/content/docs/fr/config-reference/included-integrations.mdx deleted file mode 100644 index a14aec1b..00000000 --- a/src/content/docs/fr/config-reference/included-integrations.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -i18nReady: true -title: Intégrations incluses -description: Page de référence pour les options des intégrations incluses de StudioCMS -sidebar: - order: 7 ---- - -import ReadMore from '~/components/ReadMore.astro'; - -Référence du schéma des options de configuration de l’intégration StudioCMS - -```ts twoslash title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - includedIntegrations: { - robotsTXT: true - }, -}); -``` - -## `robotsTXT` - -`robotsTXT` est un booléen ou un objet utilisé pour déterminer si le fichier robots.txt est activé. - -- **Type :** `boolean` | [`RobotsConfig`](#robotsconfig) | `undefined` -- **Par défaut :** `true` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - includedIntegrations: { - robotsTXT: true, // PAR DÉFAUT - Ceci active le fichier robots.txt. - } -}) -``` - -##### `RobotsConfig` - -```ts -interface RobotsConfig { - host?: boolean | string; - sitemap?: boolean | string | string[]; - policy?: { - userAgent?: string; - disallow?: string | string[]; - allow?: string | string[]; - crawlDelay?: number; - cleanParam?: string | string[]; - }[] | undefined; -} -``` diff --git a/src/content/docs/fr/config-reference/index.mdx b/src/content/docs/fr/config-reference/index.mdx index de6bf1b9..8cda4bfe 100644 --- a/src/content/docs/fr/config-reference/index.mdx +++ b/src/content/docs/fr/config-reference/index.mdx @@ -1,9 +1,15 @@ --- i18nReady: true -title: StudioCMSOptions +title: Options de StudioCMS description: Page de référence pour les options de StudioCMS sidebar: order: 1 + badge: + text: Mis à jour + variant: success +tableOfContents: + minHeadingLevel: 2 + maxHeadingLevel: 5 --- import ReadMore from '~/components/ReadMore.astro'; @@ -16,18 +22,12 @@ import { defineStudioCMSConfig } from 'studiocms/config'; // Valeurs par défaut affichées export default defineStudioCMSConfig({ dbStartPage: true, - dateLocale: 'en-us', verbose: false, + logLevel: 'Info', plugins: [], componentRegistry: {}, - overrides: {}, - imageService: {}, - defaultFrontEndConfig: {}, - dashboardConfig: {}, - includedIntegrations: {}, - dateTimeFormat: {}, - sdk: {}, - pageTypeOptions: {} + locale: {}, + features: {} }); ``` @@ -48,12 +48,12 @@ export default defineStudioCMSConfig({ }) ``` -## `dateLocale` +## `verbose` -`dateLocale` est une chaîne de caractères utilisée pour déterminer les paramètres régionaux pour le formatage des dates. +`verbose` est un booléen utilisé pour activer ou désactiver la journalisation détaillée. -- **Type :** `string` -- **Par défaut :** `'en-us'` +- **Type :** `boolean` +- **Par défaut :** `false` ### Utilisation @@ -61,16 +61,16 @@ export default defineStudioCMSConfig({ import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ - dateLocale: 'en-us', // PAR DÉFAUT - Ceci définit les paramètres régionaux de date pour le formatage des dates. + verbose: false, // PAR DÉFAUT - Ceci désactive la journalisation détaillée. }) ``` -## `verbose` +## `logLevel` -`verbose` est un booléen utilisé pour activer ou désactiver la journalisation détaillée. +`logLevel` est une union permettant de définir le niveau de journalisation pour le code reposant sur Effect. -- **Type :** `boolean` -- **Par défaut :** `false` +- **Type :** `All` | `Fatal` | `Error` | `Warning` | `Info` | `Debug` | `Trace` | `None` +- **Par défaut :** `Info` ### Utilisation @@ -78,7 +78,7 @@ export default defineStudioCMSConfig({ import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ - verbose: false, // PAR DÉFAUT - Ceci désactive la journalisation détaillée. + logLevel: 'Info', // PAR DÉFAUT }) ``` @@ -121,67 +121,18 @@ export default defineStudioCMSConfig({ }) ``` -## `dateTimeFormat` - -`dateTimeFormat` est un objet utilisé pour configurer le format de date et d'heure. - -- **Type :** `Intl.DateTimeFormatOptions` -- **Par défaut :** `{}` - -### Utilisation - -```ts twoslash {2-6} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - dateTimeFormat: { - year: "numeric", - month: "short", - day: "numeric" - }, -}) -``` - -## `overrides` - -`overrides` est un objet utilisé pour remplacer la configuration par défaut. - -[Consultez `overrides` pour les options complètes][overrides] - -## `imageService` - -`imageService` est un objet utilisé pour configurer le service d’images. - -[Consultez `imageService` pour les options complètes][image-service] - -## `defaultFrontEndConfig` - -`defaultFrontEndConfig` est un objet utilisé pour configurer le front-end par défaut. - -[Consultez `defaultFrontEndConfig` pour les options complètes][default-frontend-config] - -## `dashboardConfig` - -`dashboardConfig` est un objet utilisé pour configurer le tableau de bord. - -[Consultez `dashboardConfig` pour les options complètes][dashboard] - -## `includedIntegrations` +## `locale` -`includedIntegrations` est un objet utilisé pour configurer quelles intégrations doivent être incluses. +`locale` permet de définir des paramètres spécifiques aux paramètres régionaux -[Consultez `includedIntegrations` pour les options complètes][included-integrations] +[Voir `locale` pour les options complètes][locale] -## `sdk` +## `features` -`sdk` est un objet utilisé pour configurer le SDK. +`features` est un objet qui permet d'ajuster les fonctionnalités du tableau de bord de StudioCMS -[Consultez `sdk` pour les options complètes][sdk] +[Voir `features` pour les options complètes][features] -{/* Links */} -[overrides]: /fr/config-reference/overrides/ -[image-service]: /fr/config-reference/image-service/ -[default-frontend-config]: /fr/config-reference/default-frontend-config/ -[dashboard]: /fr/config-reference/dashboard/ -[included-integrations]: /fr/config-reference/included-integrations/ -[sdk]: /fr/config-reference/sdk/ +{/* Liens */} +[locale]: /fr/config-reference/locale/ +[features]: /fr/config-reference/features/ diff --git a/src/content/docs/fr/config-reference/locale.mdx b/src/content/docs/fr/config-reference/locale.mdx new file mode 100644 index 00000000..225ce58b --- /dev/null +++ b/src/content/docs/fr/config-reference/locale.mdx @@ -0,0 +1,67 @@ +--- +i18nReady: true +title: Paramètres régionaux +description: Page de référence pour les options de paramètres régionaux de StudioCMS +sidebar: + order: 2 + badge: + text: Updated + variant: success +--- + +import ReadMore from '~/components/ReadMore.astro'; + +`locale` permet de définir des préférences spécifiques aux paramètres régionaux + +```ts twoslash title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + locale: { + dateLocale: 'en-US', + dateTimeFormat: {} + }, +}); +``` + +## `dateLocale` + +`dateLocale` est un identifiant de paramètres régionaux BCP 47 utilisé pour le formatage des dates. + +- **Type :** `string` +- **Par défaut :** `'en-US'` + +### Utilisation + +```ts twoslash {3} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + locale: { + dateLocale: 'en-US', // PAR DÉFAUT - Ceci définit les paramètres régionaux de date pour le formatage de la date. + } +}) +``` + +## `dateTimeFormat` + +`dateTimeFormat` est un objet utilisé pour configurer le format de date et d'heure. + +- **Type :** `Intl.DateTimeFormatOptions` +- **Par défaut :** `{}` + +### Utilisation + +```ts twoslash {3-7} title="studiocms.config.mjs" +import { defineStudioCMSConfig } from 'studiocms/config'; +// ---cut--- +export default defineStudioCMSConfig({ + locale: { + dateTimeFormat: { + year: "numeric", + month: "short", + day: "numeric" + }, + } +}) +``` diff --git a/src/content/docs/fr/config-reference/overrides.mdx b/src/content/docs/fr/config-reference/overrides.mdx deleted file mode 100644 index 5b918efe..00000000 --- a/src/content/docs/fr/config-reference/overrides.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -i18nReady: true -title: Remplacements -description: Page de référence pour les options de remplacements de StudioCMS -sidebar: - order: 2 ---- - -import ReadMore from '~/components/ReadMore.astro'; - -Référence du schéma des options de configuration de l’intégration StudioCMS - -```ts twoslash title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - overrides: { - CustomImageOverride: 'src/components/CustomImage.astro', - FormattedDateOverride: 'src/components/FormattedDate.astro', - }, -}); -``` - -## `CustomImageOverride` - -`CustomImageOverride` est une chaîne de caractères utilisée pour déterminer le chemin d’accès au composant d’image personnalisé. - -- **Type :** `string` -- **Par défaut :** `undefined` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - overrides: { - CustomImageOverride: 'src/components/CustomImage.astro', - }, -}) -``` - -## `FormattedDateOverride` - -`FormattedDateOverride` est une chaîne de caractères utilisée pour déterminer le chemin d’accès au composant de date personnalisé. - -- **Type :** `string` -- **Par défaut :** `undefined` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - overrides: { - FormattedDateOverride: 'src/components/FormattedDate.astro', - }, -}) -``` - -### Composant par défaut - -```astro title="FormattedDate.astro" ---- -import config from 'studiocms:config'; - -interface Props { - date: Date; -} - -const datetime = Astro.props.date.toISOString(); -const formattedDate = Astro.props.date.toLocaleDateString(config.dateLocale, config.dateTimeFormat); ---- - - -``` diff --git a/src/content/docs/fr/config-reference/sdk.mdx b/src/content/docs/fr/config-reference/sdk.mdx deleted file mode 100644 index 0b6ea5f7..00000000 --- a/src/content/docs/fr/config-reference/sdk.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -i18nReady: true -title: SDK -description: Page de référence pour les options du SDK de StudioCMS -sidebar: - order: 8 ---- - -import ReadMore from '~/components/ReadMore.astro'; - -Référence du schéma des options de configuration de l’intégration StudioCMS - -```ts twoslash title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - sdk: { - cacheConfig: {}, - }, -}); -``` - -## `cacheConfig` - -`cacheConfig` est un objet utilisé pour configurer le cache du SDK. - -- **Type :** `boolean` | `{ lifetime?: string | undefined; }` | `undefined` -- **Par défaut :** `{}` - -### Utilisation - -```ts twoslash {3} title="studiocms.config.mjs" -import { defineStudioCMSConfig } from 'studiocms/config'; -// ---cut--- -export default defineStudioCMSConfig({ - sdk: { - // PAR DÉFAUT - Ceci utilise la configuration de cache par défaut. - cacheConfig: { - lifetime: '5m', - }, - } -}) -```