Skip to content

Commit

Permalink
Merge branch 'main' into hd-i18next
Browse files Browse the repository at this point in the history
* main: (22 commits)
  i18n(ru): update `ru/manual-setup.mdx` and `ru/reference/configuration.mdx` (withastro#2307)
  [ci] format
  i18n(ru): update some guides (withastro#2306)
  i18n(fr): update `manual-setup` (withastro#2299)
  i18n(fr): update `guides/pages` (withastro#2298)
  [ci] release (withastro#2304)
  Convert URL to file path correctly for Git virtual module (withastro#2303)
  i18n(fr): update `reference/configuration` (withastro#2296)
  i18n(fr): update `guides/authoring-content` (withastro#2297)
  Update `yummacss.com.png` thumbnail (withastro#2301)
  i18n(ko-KR): update `pages.mdx` (withastro#2293)
  [ci] format
  i18n(ko-KR): update `authoring-content.mdx` (withastro#2300)
  [ci] format
  i18n(ko-KR): update `manual-setup.mdx` (withastro#2294)
  i18n(ko-KR): update `configuration.mdx` (withastro#2295)
  [ci] release (withastro#2292)
  Add support for SSR (withastro#1255)
  Add Markdoc preset and example (withastro#2249)
  Refactor sidebar persistence logic for better slow device performance (withastro#2242)
  ...
  • Loading branch information
HiDeoo committed Sep 9, 2024
2 parents 3f57de0 + c0610a8 commit 4a9f210
Show file tree
Hide file tree
Showing 105 changed files with 2,541 additions and 285 deletions.
3 changes: 3 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,8 @@ i18n:
'🌟 tailwind':
- packages/tailwind/**

'🌟 markdoc':
- packages/markdoc/**

'📚 docs':
- docs/**
Binary file added docs/src/assets/showcase/docs.ryzekit.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/assets/showcase/yummacss.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/src/components/showcase-sites.astro
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,9 @@ import FluidGrid from './fluid-grid.astro';
thumbnail="developers.cloudflare.com.png"
/>
<Card title="Yumma CSS" href="https://www.yummacss.com/" thumbnail="yummacss.com.png" />
<Card
title="RyzeKit Astro SaaS Starter"
href="https://docs.ryzekit.com/"
thumbnail="docs.ryzekit.com.png"
/>
</FluidGrid>
Original file line number Diff line number Diff line change
Expand Up @@ -202,17 +202,17 @@ Un bloc de code est indiqué par un bloc avec trois accents graves <code>```</co
```js
// Code Javascript avec coloration syntaxique.
var fun = function lang(l) {
dateformat.i18n = require('./lang/' + l);
return true;
dateformat.i18n = require('./lang/' + l);
return true;
};
```

````md
```js
// Code Javascript avec coloration syntaxique.
var fun = function lang(l) {
dateformat.i18n = require('./lang/' + l);
return true;
dateformat.i18n = require('./lang/' + l);
return true;
};
```
````
Expand Down Expand Up @@ -240,16 +240,16 @@ Certaines des options les plus courantes sont présentées ci-dessous :

```js {2-3}
function demo() {
// Cette ligne (#2) et la suivante sont mises en évidence
return 'Ceci est la ligne #3 de cet exemple';
// Cette ligne (#2) et la suivante sont mises en évidence
return 'Ceci est la ligne #3 de cet exemple';
}
```

````md
```js {2-3}
function demo() {
// Cette ligne (#2) et la suivante sont mises en évidence
return 'Ceci est la ligne #3 de cet exemple';
// Cette ligne (#2) et la suivante sont mises en évidence
return 'Ceci est la ligne #3 de cet exemple';
}
```
````
Expand All @@ -259,15 +259,15 @@ Certaines des options les plus courantes sont présentées ci-dessous :
```js "termes individuels" /Même.*charge/
// Des termes individuels peuvent également être mis en évidence
function demo() {
return 'Même les expressions régulières sont prises en charge';
return 'Même les expressions régulières sont prises en charge';
}
```

````md
```js "termes individuels" /Même.*charge/
// Des termes individuels peuvent également être mis en évidence
function demo() {
return 'Même les expressions régulières sont prises en charge';
return 'Même les expressions régulières sont prises en charge';
}
```
````
Expand All @@ -276,18 +276,18 @@ Certaines des options les plus courantes sont présentées ci-dessous :

```js "return true;" ins="insertion" del="suppression"
function demo() {
console.log("Voici des marqueurs d'insertion et de suppression");
// La déclaration return utilise le type de marqueur par défaut
return true;
console.log("Voici des marqueurs d'insertion et de suppression");
// La déclaration return utilise le type de marqueur par défaut
return true;
}
```

````md
```js "return true;" ins="insertion" del="suppression"
function demo() {
console.log("Voici des marqueurs d'insertion et de suppression");
// La déclaration return utilise le type de marqueur par défaut
return true;
console.log("Voici des marqueurs d'insertion et de suppression");
// La déclaration return utilise le type de marqueur par défaut
return true;
}
```
````
Expand Down Expand Up @@ -392,3 +392,118 @@ Starlight prend en charge toutes les autres syntaxes de rédaction Markdown, tel
## Configuration avancée de Markdown et MDX
Starlight utilise le moteur de rendu Markdown et MDX d'Astro basé sur remark et rehype. Vous pouvez ajouter la prise en charge de syntaxe et comportement personnalisés en ajoutant `remarkPlugins` ou `rehypePlugins` dans votre fichier de configuration Astro. Pour en savoir plus, consultez [« Configuration de Markdown et MDX »](https://docs.astro.build/fr/guides/markdown-content/#configuration-de-markdown-et-mdx) dans la documentation d'Astro.

## Markdoc

Starlight supporte la création de contenu en Markdoc en utilisant l'intégration expérimentale [Astro Markdoc](https://docs.astro.build/fr/guides/integrations-guide/markdoc/) et la préconfiguration Markdoc de Starlight.
### Créer un nouveau projet avec Markdoc
Créez un nouveau projet Starlight avec Markdoc préconfiguré en utilisant `create astro` :
import { Tabs, TabItem, Steps } from '@astrojs/starlight/components';
<Tabs syncKey="pkg">
<TabItem label="npm">
```sh
npm create astro@latest -- --template starlight/markdoc
```
</TabItem>
<TabItem label="pnpm">
```sh
pnpm create astro --template starlight/markdoc
```
</TabItem>
<TabItem label="Yarn">
```sh
yarn create astro --template starlight/markdoc
```
</TabItem>
</Tabs>
### Ajouter Markdoc à un projet existant
Si vous disposez déjà d'un site Starlight et que vous souhaitez ajouter Markdoc, suivez ces étapes.

<Steps>

1. Ajoutez l'intégration Markdoc d'Astro :

<Tabs syncKey="pkg">

<TabItem label="npm">

```sh
npx astro add markdoc
```

</TabItem>

<TabItem label="pnpm">

```sh
pnpm astro add markdoc
```

</TabItem>

<TabItem label="Yarn">

```sh
yarn astro add markdoc
```

</TabItem>

</Tabs>

2. Installez la préconfiguration Markdoc de Starlight :

<Tabs syncKey="pkg">

<TabItem label="npm">

```sh
npm install @astrojs/starlight-markdoc
```

</TabItem>

<TabItem label="pnpm">

```sh
pnpm add @astrojs/starlight-markdoc
```

</TabItem>

<TabItem label="Yarn">

```sh
yarn add @astrojs/starlight-markdoc
```

</TabItem>

</Tabs>

3. Créez une configuration Markdoc dans le fichier `markdoc.config.mjs` et utilisez la préconfiguration Markdoc de Starlight :

```js
import { defineMarkdocConfig } from '@astrojs/markdoc/config';
import starlightMarkdoc from '@astrojs/starlight-markdoc';
export default defineMarkdocConfig({
extends: [starlightMarkdoc()],
});
```

</Steps>

Pour en savoir plus sur la syntaxe et les fonctionnalités de Markdoc, consultez la [documentation Markdoc](https://markdoc.dev/docs/syntax) ou le [guide de l'intégration Astro Markdoc](https://docs.astro.build/fr/guides/integrations-guide/markdoc/).
2 changes: 1 addition & 1 deletion docs/src/content/docs/fr/guides/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Ce guide montre comment fonctionne la génération de pages dans Starlight.
### Formats de fichiers

Starlight prend en charge la création de contenu en Markdown et MDX sans aucune configuration requise.
Vous pouvez ajouter la prise en charge de Markdoc en installant l'intégration expérimentale [Astro Markdoc](https://docs.astro.build/fr/guides/integrations-guide/markdoc/).
Vous pouvez ajouter la prise en charge de Markdoc en suivant le [guide « Markdoc »](/fr/guides/authoring-content/#markdoc).

### Ajouter des pages

Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/fr/manual-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,6 @@ import { FileTree } from '@astrojs/starlight/components';
### Utiliser Starlight avec SSR
Vous pouvez utiliser Starlight en parallèle de pages personnalisées rendues à la demande dans votre projet en suivant le guide [« Adaptateurs de rendu à la demande »](https://docs.astro.build/fr/guides/server-side-rendering/) dans la documentation d'Astro.
Pour activer le SSR, suivez le guide [« Adaptateurs de rendu à la demande »](https://docs.astro.build/fr/guides/server-side-rendering/) dans la documentation d'Astro pour ajouter un adaptateur serveur à votre projet Starlight.

À l'heure actuelle, les pages de documentation générées par Starlight sont toujours pré-rendues, quel que soit le mode de rendu de votre projet. Nous espérons pouvoir bientôt supporter le rendu à la demande pour les pages de Starlight.
Les pages de documentation générées par Starlight sont pré-rendues par défaut, quel que soit le mode de rendu de votre projet. Pour désactiver le pré-rendu de vos pages Starlight, définissez [l'option de configuration `prerender`](/fr/reference/configuration/#prerender) à `false`.
10 changes: 10 additions & 0 deletions docs/src/content/docs/fr/reference/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,16 @@ Définit si le système de recherche du site par défaut de Starlight, [Pagefind
Utilisez la valeur `false` pour désactiver l'indexation de votre site avec Pagefind.
Cela désactivera également l'interface de recherche par défaut de Starlight si utilisée.

### `prerender`

**Type :** `boolean`
**Par défaut :** `true`

Définit si les pages générées par Starlight doivent être pré-rendues en HTML statique ou rendues à la demande par un [adaptateur SSR](https://docs.astro.build/fr/guides/server-side-rendering/).

Les pages Starlight sont pré-rendues par défaut.
Si vous utilisez un adaptateur SSR et que vous souhaitez générer les pages Starlight à la demande, définissez `prerender: false`.

### `head`

**Type :** [`HeadConfig[]`](#headconfig)
Expand Down
Loading

0 comments on commit 4a9f210

Please sign in to comment.