diff options
author | HiDeoo | 2024-09-19 14:40:49 +0200 |
---|---|---|
committer | GitHub | 2024-09-19 14:40:49 +0200 |
commit | c754b1b4c5bf4ec55cb58b3424975996327171b6 (patch) | |
tree | 0db4b53bb43a0428a8e4ec9d99c3ec721f1c2645 | |
parent | b9e7fd39e9264d2efabc7e3bac22b2d2b7bbe0c2 (diff) | |
download | IT.starlight-c754b1b4c5bf4ec55cb58b3424975996327171b6.tar.gz IT.starlight-c754b1b4c5bf4ec55cb58b3424975996327171b6.tar.bz2 IT.starlight-c754b1b4c5bf4ec55cb58b3424975996327171b6.zip |
i18n(fr): add `components/code` (#2368)
Co-authored-by: Thomas Bonnet <14293805+thomasbnt@users.noreply.github.com>
-rw-r--r-- | docs/src/content/docs/fr/components/code.mdx | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/docs/src/content/docs/fr/components/code.mdx b/docs/src/content/docs/fr/components/code.mdx new file mode 100644 index 00000000..72d6e6e0 --- /dev/null +++ b/docs/src/content/docs/fr/components/code.mdx @@ -0,0 +1,103 @@ +--- +title: Code +description: Apprenez à afficher du code avec coloration syntaxique dans Starlight sans blocs de code Markdown. +--- + +import { Code } from '@astrojs/starlight/components'; + +Le composant `<Code>` affiche du code avec coloration syntaxique. +Il est utile lorsque l'utilisation d'un [bloc de code Markdown](/fr/guides/authoring-content/#blocs-de-code) n'est pas possible, par exemple pour afficher des données provenant de sources externes comme des fichiers, des bases de données ou des API. + +import Preview from '~/components/component-preview.astro'; + +<Preview> + +<Code + slot="preview" + code={`## Bienvenue + +Bonjour depuis **l'espace**!`} +lang="md" +title="exemple.md" +ins={3} +/> + +</Preview> + +## Import + +```tsx +import { Code } from '@astrojs/starlight/components'; +``` + +## Utilisation + +Utilisez le composant `<Code>` pour afficher du code avec coloration syntaxique, par exemple lorsque vous affichez du code provenant de sources externes. + +Consultez la [documentation sur le « Composant Code » d'Expressive Code](https://expressive-code.com/key-features/code-component/) pour plus de détails sur l'utilisation du composant `<Code>` et la liste des props disponibles. + +<Preview> + +```mdx +import { Code } from '@astrojs/starlight/components'; + +export const exampleCode = `console.log("Cela peut provenir d'un fichier ou d'un CMS !");`; +export const fileName = 'exemple.js'; +export const highlights = ['fichier', 'CMS']; + +<Code code={exampleCode} lang="js" title={fileName} mark={highlights} /> +``` + +<Fragment slot="markdoc"> + +```markdoc +{% code + code="console.log(\"Cela peut provenir d'un fichier ou d'un CMS !\");" + lang="js" + title="exemple.js" + meta="'fichier' 'CMS'" /%} +``` + +</Fragment> + +export const exampleCode = `console.log("Cela peut provenir d'un fichier ou d'un CMS !");`; +export const fileName = 'exemple.js'; +export const highlights = ['fichier', 'CMS']; + +<Code + slot="preview" + code={exampleCode} + lang="js" + title={fileName} + mark={highlights} +/> + +</Preview> + +### Afficher du code importé + +Dans les fichiers MDX et les composants Astro, utilisez le [suffixe d'import `?raw` de Vite](https://vitejs.dev/guide/assets#importing-asset-as-string) pour importer n'importe quel fichier de code sous forme de chaîne de caractères. +Vous pouvez ensuite passer cette chaîne importée au composant `<Code>` pour l'inclure dans votre page. + +<Preview> + +```mdx "?raw" +# src/content/docs/example.mdx + +import { Code } from '@astrojs/starlight/components'; +import importedCode from '/src/env.d.ts?raw'; + +<Code code={importedCode} lang="ts" title="src/env.d.ts" /> +``` + +import importedCode from '/src/env.d.ts?raw'; + +<Code slot="preview" code={importedCode} lang="ts" title="src/env.d.ts" /> + +</Preview> + +## Props de `<Code>` + +**Implémentation :** [`Code.astro`](https://github.com/expressive-code/expressive-code/blob/main/packages/astro-expressive-code/components/Code.astro) + +Le composant `<Code>` accepte toutes les props documentées dans la [documentation sur le « Composant Code » d'Expressive Code](https://expressive-code.com/key-features/code-component/#available-props). |