From 940672cc4a00060bc59d56d212514241dcd37645 Mon Sep 17 00:00:00 2001 From: Chris Swithinbank Date: Wed, 7 Jun 2023 12:39:10 +0200 Subject: Docs housekeeping (#170) --- docs/src/content/docs/de/getting-started.mdx | 6 +++--- .../src/content/docs/de/reference/configuration.md | 2 +- docs/src/content/docs/environmental-impact.md | 4 ++++ docs/src/content/docs/es/environmental-impact.md | 7 ++++++- docs/src/content/docs/es/getting-started.mdx | 8 ++++---- .../content/docs/es/guides/authoring-content.md | 7 +++---- .../src/content/docs/es/reference/configuration.md | 4 ++-- docs/src/content/docs/fr/environmental-impact.md | 23 +++++++++++++--------- docs/src/content/docs/fr/getting-started.mdx | 9 +++++---- .../content/docs/fr/guides/authoring-content.md | 2 +- .../src/content/docs/fr/reference/configuration.md | 4 ++-- docs/src/content/docs/getting-started.mdx | 8 ++++---- docs/src/content/docs/guides/authoring-content.md | 14 ++++++------- docs/src/content/docs/ja/environmental-impact.md | 5 +++++ docs/src/content/docs/ja/getting-started.mdx | 6 +++--- .../content/docs/ja/guides/authoring-content.md | 2 +- docs/src/content/docs/reference/configuration.md | 4 ++-- 17 files changed, 66 insertions(+), 49 deletions(-) diff --git a/docs/src/content/docs/de/getting-started.mdx b/docs/src/content/docs/de/getting-started.mdx index 47cf01c4..b114e30e 100644 --- a/docs/src/content/docs/de/getting-started.mdx +++ b/docs/src/content/docs/de/getting-started.mdx @@ -62,9 +62,9 @@ Starlight unterstützt das Erstellen von Inhalten in Markdown und MDX. (Du kanns Füge neue Seiten zu deiner Webseite automatisch hinzu, indem du `.md` oder `.mdx` Dateien in `src/content/docs/` erstellst. Erstelle Unterordner, um deine Dateien zu organisieren und mehrere Pfadsegmente zu erstellen: -```js -`src/content/docs/hello-world.md` -> `your-site/hello-world` -`src/content/docs/guides/faq.md` -> `your-site/guides/faq` +``` +src/content/docs/hello-world.md => your-site.com/hello-world +src/content/docs/guides/faq.md => your-site.com/guides/faq ``` ### Typsichere Frontmatter diff --git a/docs/src/content/docs/de/reference/configuration.md b/docs/src/content/docs/de/reference/configuration.md index b4aef5e3..d878d04c 100644 --- a/docs/src/content/docs/de/reference/configuration.md +++ b/docs/src/content/docs/de/reference/configuration.md @@ -15,7 +15,7 @@ import starlight from '@astrojs/starlight'; export default defineConfig({ integrations: [ starlight({ - title: "My delightful docs site", + title: 'My delightful docs site', }), ], }); diff --git a/docs/src/content/docs/environmental-impact.md b/docs/src/content/docs/environmental-impact.md index f1695ee3..95f06a36 100644 --- a/docs/src/content/docs/environmental-impact.md +++ b/docs/src/content/docs/environmental-impact.md @@ -93,9 +93,11 @@ These tests with the [Website Carbon Calculator][wcc] compare similar pages buil | --------------------------- | ------------------ | | [Starlight][sl-carbon] | 0.01g | | [VitePress][vp-carbon] | 0.05g | +| [Docus][dc-carbon] | 0.05g | | [Sphinx][sx-carbon] | 0.07g | | [MkDocs][mk-carbon] | 0.10g | | [Nextra][nx-carbon] | 0.11g | +| [docsify][dy-carbon] | 0.11g | | [Docusaurus][ds-carbon] | 0.24g | | [Read the Docs][rtd-carbon] | 0.24g | | [GitBook][gb-carbon] | 0.71g | @@ -104,9 +106,11 @@ These tests with the [Website Carbon Calculator][wcc] compare similar pages buil [sl-carbon]: https://www.websitecarbon.com/website/starlight-astro-build-getting-started/ [vp-carbon]: https://www.websitecarbon.com/website/vitepress-dev-guide-what-is-vitepress/ +[dc-carbon]: https://www.websitecarbon.com/website/docus-dev-introduction-getting-started/ [sx-carbon]: https://www.websitecarbon.com/website/sphinx-doc-org-en-master-usage-quickstart-html/ [mk-carbon]: https://www.websitecarbon.com/website/mkdocs-org-getting-started/ [nx-carbon]: https://www.websitecarbon.com/website/nextra-site-docs-docs-theme-start/ +[dy-carbon]: https://www.websitecarbon.com/website/docsify-js-org/ [ds-carbon]: https://www.websitecarbon.com/website/docusaurus-io-docs/ [rtd-carbon]: https://www.websitecarbon.com/website/docs-readthedocs-io-en-stable-index-html/ [gb-carbon]: https://www.websitecarbon.com/website/docs-gitbook-com/ diff --git a/docs/src/content/docs/es/environmental-impact.md b/docs/src/content/docs/es/environmental-impact.md index 7d5c6e40..32c24f7f 100644 --- a/docs/src/content/docs/es/environmental-impact.md +++ b/docs/src/content/docs/es/environmental-impact.md @@ -77,9 +77,11 @@ Estas pruebas con el [Calculadora de Carbono de Sitios Web][wcc] comparan págin | --------------------------- | -------------------------- | | [Starlight][sl-carbon] | 0.01g | | [VitePress][vp-carbon] | 0.05g | +| [Docus][dc-carbon] | 0.05g | | [Sphinx][sx-carbon] | 0.07g | -| [Nextra][nx-carbon] | 0.11g | | [MkDocs][mk-carbon] | 0.10g | +| [Nextra][nx-carbon] | 0.11g | +| [docsify][dy-carbon] | 0.11g | | [Docusaurus][ds-carbon] | 0.24g | | [Read the Docs][rtd-carbon] | 0.24g | | [GitBook][gb-carbon] | 0.71g | @@ -88,9 +90,11 @@ Estas pruebas con el [Calculadora de Carbono de Sitios Web][wcc] comparan págin [sl-carbon]: https://www.websitecarbon.com/website/starlight-astro-build-getting-started/ [vp-carbon]: https://www.websitecarbon.com/website/vitepress-dev-guide-what-is-vitepress/ +[dc-carbon]: https://www.websitecarbon.com/website/docus-dev-introduction-getting-started/ [sx-carbon]: https://www.websitecarbon.com/website/sphinx-doc-org-en-master-usage-quickstart-html/ [mk-carbon]: https://www.websitecarbon.com/website/mkdocs-org-getting-started/ [nx-carbon]: https://www.websitecarbon.com/website/nextra-site-docs-docs-theme-start/ +[dy-carbon]: https://www.websitecarbon.com/website/docsify-js-org/ [ds-carbon]: https://www.websitecarbon.com/website/docusaurus-io-docs/ [rtd-carbon]: https://www.websitecarbon.com/website/docs-readthedocs-io-en-stable-index-html/ [gb-carbon]: https://www.websitecarbon.com/website/docs-gitbook-com/ @@ -100,6 +104,7 @@ Estas pruebas con el [Calculadora de Carbono de Sitios Web][wcc] comparan págin ### Herramientas - [Calculadora de Carbono de Sitios Web][wcc] +- [GreenFrame](https://greenframe.io/) - [Ecograder](https://ecograder.com/) - [Control de Carbono WebPageTest](https://www.webpagetest.org/carbon-control/) - [Ecoping](https://ecoping.earth/) diff --git a/docs/src/content/docs/es/getting-started.mdx b/docs/src/content/docs/es/getting-started.mdx index e3e157a7..d4b75107 100644 --- a/docs/src/content/docs/es/getting-started.mdx +++ b/docs/src/content/docs/es/getting-started.mdx @@ -61,9 +61,9 @@ Starlight admite la creación de contenido en Markdown y MDX. (Puedes agregar co Agrega nuevas páginas a tu sitio automáticamente creando archivos `.md` o `.mdx` en `src/content/docs/`. Agrega subcarpetas para organizar tus archivos y crear segmentos de ruta múltiples. -```js -`src/content/docs/hello-world.md` -> `tu-sitio/hello-world` -`src/content/docs/guides/faq.md` -> `tu-sitio/guides/faq` +``` +src/content/docs/hello-world.md => tu-sitio.com/hello-world +src/content/docs/guides/faq.md => tu-sitio.com/guides/faq ``` ### Frontmatter con seguridad de tipos @@ -120,4 +120,4 @@ yarn upgrade @astrojs/starlight --latest -Puedes ver una lista completa de los cambios realizados en cada versión en [el registro de cambios de Starlight](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md). \ No newline at end of file +Puedes ver una lista completa de los cambios realizados en cada versión en [el registro de cambios de Starlight](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md). diff --git a/docs/src/content/docs/es/guides/authoring-content.md b/docs/src/content/docs/es/guides/authoring-content.md index 5160a897..129dda4f 100644 --- a/docs/src/content/docs/es/guides/authoring-content.md +++ b/docs/src/content/docs/es/guides/authoring-content.md @@ -44,10 +44,9 @@ También se admiten rutas de imágenes relativas para imágenes almacenadas loca ```md // src/content/docs/page-1.md -![Una nave espacial en el espacio.](../../assets/images/rocket.svg) +![Una nave espacial en el espacio](../../assets/images/rocket.svg) ``` - ## Encabezados Puedes estructurar el contenido utilizando encabezados. Los encabezados en Markdown se indican con uno o más `#` al comienzo de la línea. @@ -67,7 +66,6 @@ Esta página describe cómo utilizar Markdown en Starlight. ## Estilos en línea ## Encabezados - ``` ### Enlaces de anclaje automáticos para encabezados. @@ -79,6 +77,7 @@ Al utilizar encabezados en Markdown, se generan automáticamente enlaces de ancl title: Mi página de contenido description: Cómo utilizar los enlaces de anclaje integrados de Starlight. --- + ## Introducción Puedo enlazar a [mi conclusión](#conclusión) más abajo en la misma página. @@ -87,8 +86,8 @@ Puedo enlazar a [mi conclusión](#conclusión) más abajo en la misma página. `https://mi-sitio.com/page1/#introduction` navega directamente a mi Introducción. ``` -Los encabezados de nivel 2 (`

`) y nivel 3 (`

`) aparecerán automáticamente en la tabla de contenido de la página. +Los encabezados de nivel 2 (`

`) y nivel 3 (`

`) aparecerán automáticamente en la tabla de contenido de la página. ## Apartados diff --git a/docs/src/content/docs/es/reference/configuration.md b/docs/src/content/docs/es/reference/configuration.md index a19075fb..5b9b7a78 100644 --- a/docs/src/content/docs/es/reference/configuration.md +++ b/docs/src/content/docs/es/reference/configuration.md @@ -5,7 +5,7 @@ description: Una descripción general de todas las opciones de configuración qu ## Configurar la integración `starlight` -Starlight es una integración construida sobre el framework [Astro](https://astro.build). Puedes configurar tu proyecto dentro del archivo de configuración de Astro `astro.config.mjs`: +Starlight es una integración construida sobre el framework [Astro](https://astro.build). Puedes configurar tu proyecto dentro del archivo de configuración `astro.config.mjs`: ```js // astro.config.mjs @@ -14,7 +14,7 @@ import starlight from '@astrojs/starlight'; export default defineConfig({ integrations: [ starlight({ - title: "My delightful docs site", + title: 'My delightful docs site', }), ], }); diff --git a/docs/src/content/docs/fr/environmental-impact.md b/docs/src/content/docs/fr/environmental-impact.md index 9e552f60..6afb6fe3 100644 --- a/docs/src/content/docs/fr/environmental-impact.md +++ b/docs/src/content/docs/fr/environmental-impact.md @@ -90,23 +90,27 @@ Curieux de savoir comment les autres frameworks de documentation se comparent ? Ces tests avec le [Website Carbon Calculator][wcc] comparent des pages similaires construites avec différents outils. | Framework | CO₂ par page visitée | -| --------------------------- | ------------------ | -| [Starlight][sl-carbon] | 0.01g | -| [VitePress][vp-carbon] | 0.05g | -| [Sphinx][sx-carbon] | 0.07g | -| [MkDocs][mk-carbon] | 0.10g | -| [Nextra][nx-carbon] | 0.11g | -| [Docusaurus][ds-carbon] | 0.24g | -| [Read the Docs][rtd-carbon] | 0.24g | -| [GitBook][gb-carbon] | 0.71g | +| --------------------------- | -------------------- | +| [Starlight][sl-carbon] | 0.01g | +| [VitePress][vp-carbon] | 0.05g | +| [Docus][dc-carbon] | 0.05g | +| [Sphinx][sx-carbon] | 0.07g | +| [MkDocs][mk-carbon] | 0.10g | +| [Nextra][nx-carbon] | 0.11g | +| [docsify][dy-carbon] | 0.11g | +| [Docusaurus][ds-carbon] | 0.24g | +| [Read the Docs][rtd-carbon] | 0.24g | +| [GitBook][gb-carbon] | 0.71g | Données collectées le 14 mai 2023. Cliquez sur un lien pour voir les chiffres actualisés. [sl-carbon]: https://www.websitecarbon.com/website/starlight-astro-build-getting-started/ [vp-carbon]: https://www.websitecarbon.com/website/vitepress-dev-guide-what-is-vitepress/ +[dc-carbon]: https://www.websitecarbon.com/website/docus-dev-introduction-getting-started/ [sx-carbon]: https://www.websitecarbon.com/website/sphinx-doc-org-en-master-usage-quickstart-html/ [mk-carbon]: https://www.websitecarbon.com/website/mkdocs-org-getting-started/ [nx-carbon]: https://www.websitecarbon.com/website/nextra-site-docs-docs-theme-start/ +[dy-carbon]: https://www.websitecarbon.com/website/docsify-js-org/ [ds-carbon]: https://www.websitecarbon.com/website/docusaurus-io-docs/ [rtd-carbon]: https://www.websitecarbon.com/website/docs-readthedocs-io-en-stable-index-html/ [gb-carbon]: https://www.websitecarbon.com/website/docs-gitbook-com/ @@ -116,6 +120,7 @@ Ces tests avec le [Website Carbon Calculator][wcc] comparent des pages similaire ### Outils - [Website Carbon Calculator][wcc] +- [GreenFrame](https://greenframe.io/) - [Ecograder](https://ecograder.com/) - [WebPageTest Carbon Control](https://www.webpagetest.org/carbon-control/) - [Ecoping](https://ecoping.earth/) diff --git a/docs/src/content/docs/fr/getting-started.mdx b/docs/src/content/docs/fr/getting-started.mdx index d076bc49..907c7144 100644 --- a/docs/src/content/docs/fr/getting-started.mdx +++ b/docs/src/content/docs/fr/getting-started.mdx @@ -7,7 +7,7 @@ import { Tabs, TabItem } from '@astrojs/starlight/components'; :::caution[Work in progress] Starlight est en début de développement. -Si vous trouvez quelque chose qui ne fonctionne pas, [ouvrez une issue sur GitHub](https://github.com/withastro/starlight/issues/new/choose) ou faites-le nous savoir sur [Discord](https://astro.build/chat). +Si vous trouvez quelque chose qui ne fonctionne pas, [ouvrez une issue sur GitHub](https://github.com/withastro/starlight/issues/new/choose) ou faites-le nous savoir sur [Discord](https://astro.build/chat). ::: ## Créer un nouveau projet @@ -59,11 +59,12 @@ Starlight est conçu pour que vous puissiez ajouter du nouveau contenu, ou appor Starlight prend en charge la création de contenu en Markdown et MDX. (Vous pouvez ajouter la prise en charge de Markdoc en installant l'intégration expérimentale [Astro Markdoc integration](https://docs.astro.build/fr/guides/integrations-guide/markdoc/).) ### Ajouter des pages + Ajoutez automatiquement de nouvelles pages à votre site en créant des fichiers `.md` ou `.mdx` dans `src/content/docs/`. Ajoutez des sous-dossiers pour organiser vos fichiers, et pour créer plusieurs segments de chemin : -```js -`src/content/docs/hello-world.md` -> `votre-site/hello-world` -`src/content/docs/guides/faq.md` -> `votre-site/guides/faq` +``` +src/content/docs/hello-world.md => votre-site.com/hello-world +src/content/docs/guides/faq.md => votre-site.com/guides/faq ``` ### Type-safe frontmatter diff --git a/docs/src/content/docs/fr/guides/authoring-content.md b/docs/src/content/docs/fr/guides/authoring-content.md index 35a11763..f5760200 100644 --- a/docs/src/content/docs/fr/guides/authoring-content.md +++ b/docs/src/content/docs/fr/guides/authoring-content.md @@ -44,7 +44,7 @@ Les chemins d'accès relatifs aux images sont également supportés pour les ima ```md // src/content/docs/page-1.md -![Une fusée dans l'espace.](../../assets/images/rocket.svg) +![Une fusée dans l'espace](../../assets/images/rocket.svg) ``` ## En-têtes diff --git a/docs/src/content/docs/fr/reference/configuration.md b/docs/src/content/docs/fr/reference/configuration.md index 4e6ab2f9..10ccfc17 100644 --- a/docs/src/content/docs/fr/reference/configuration.md +++ b/docs/src/content/docs/fr/reference/configuration.md @@ -5,7 +5,7 @@ description: Une vue d'ensemble de toutes les options de configuration prises en ## Configuration de l'intégration `starlight` -Starlight est une intégration construite sur le framework web [Astro](https://astro.build). Vous pouvez configurer votre projet dans le fichier de configuration Astro `astro.config.mjs` : +Starlight est une intégration construite sur le framework web [Astro](https://astro.build). Vous pouvez configurer votre projet dans le fichier de configuration `astro.config.mjs` : ```js // astro.config.mjs @@ -15,7 +15,7 @@ import starlight from '@astrojs/starlight'; export default defineConfig({ integrations: [ starlight({ - title: "Mon délicieux site de docs", + title: 'Mon délicieux site de docs', }), ], }); diff --git a/docs/src/content/docs/getting-started.mdx b/docs/src/content/docs/getting-started.mdx index 1dc224c1..b83d0bfa 100644 --- a/docs/src/content/docs/getting-started.mdx +++ b/docs/src/content/docs/getting-started.mdx @@ -58,13 +58,13 @@ Starlight is ready for you to add new content, or bring your existing files! Starlight supports authoring content in Markdown and MDX. (You can add support for Markdoc by installing the experimental [Astro Markdoc integration](https://docs.astro.build/en/guides/integrations-guide/markdoc/).) - ### Add pages + Add new pages to your site automatically by creating `.md` or `.mdx` files in `src/content/docs/`. Add sub-folders to organize your files, and to create multiple path segments: -```js -`src/content/docs/hello-world.md` -> `your-site/hello-world` -`src/content/docs/guides/faq.md` -> `your-site/guides/faq` +``` +src/content/docs/hello-world.md => your-site.com/hello-world +src/content/docs/guides/faq.md => your-site.com/guides/faq ``` ### Type-safe frontmatter diff --git a/docs/src/content/docs/guides/authoring-content.md b/docs/src/content/docs/guides/authoring-content.md index 52896a03..c74d5352 100644 --- a/docs/src/content/docs/guides/authoring-content.md +++ b/docs/src/content/docs/guides/authoring-content.md @@ -3,7 +3,7 @@ title: Authoring Content in Markdown description: An overview of the Markdown syntax Starlight supports. --- -Starlight supports the full range of [Markdown](https://daringfireball.net/projects/markdown/) syntax in `.md` files as well as frontmatter [YAML](https://dev.to/paulasantamaria/introduction-to-yaml-125f) to define metadata such as a title and description. +Starlight supports the full range of [Markdown](https://daringfireball.net/projects/markdown/) syntax in `.md` files as well as frontmatter [YAML](https://dev.to/paulasantamaria/introduction-to-yaml-125f) to define metadata such as a title and description. Please be sure to check the [MDX docs](https://mdxjs.com/docs/what-is-mdx/#markdown) or [Markdoc docs](https://markdoc.dev/docs/syntax) if using those file formats, as Markdown support and usage can differ. @@ -44,13 +44,12 @@ Relative image paths are also supported for images stored locally in your projec ```md // src/content/docs/page-1.md -![A rocketship in space.](../../assets/images/rocket.svg) +![A rocketship in space](../../assets/images/rocket.svg) ``` - ## Headings -You can structure content using a heading. Headings in Markdown are indicated by a number of `#` at the start of the line. +You can structure content using a heading. Headings in Markdown are indicated by a number of `#` at the start of the line. ### How to structure page content in Starlight @@ -67,7 +66,6 @@ This page describes how to use Markdown in Starlight. ## Inline Styles ## Headings - ``` ### Automatic heading anchor links @@ -79,16 +77,17 @@ Using headings in Markdown will automatically give you anchor links so you can l title: My page of content description: How to use Starlight's built-in anchor links --- + ## Introduction I can link to [my conclusion](#conclusion) lower on the same page. ## Conclusion -`https://my-site.com/page1/#introduction` navigates directly to my Introduction. +`https://my-site.com/page1/#introduction` navigates directly to my Introduction. ``` -Level 2 (`

`) and Level 3 (`

`) headings will automatically appear in the page table of contents. +Level 2 (`

`) and Level 3 (`

`) headings will automatically appear in the page table of contents. ## Asides @@ -208,4 +207,3 @@ Long, single-line code blocks should not wrap. They should horizontally scroll i ## Other common Markdown features Starlight supports all other Markdown authoring syntax, such as lists and tables. See the [Markdown Cheat Sheet from The Markdown Guide](https://www.markdownguide.org/cheat-sheet/) for a quick overview of all the Markdown syntax elements. - diff --git a/docs/src/content/docs/ja/environmental-impact.md b/docs/src/content/docs/ja/environmental-impact.md index 4abd73ee..b64899dd 100644 --- a/docs/src/content/docs/ja/environmental-impact.md +++ b/docs/src/content/docs/ja/environmental-impact.md @@ -76,9 +76,11 @@ JavaScriptの解析とコンパイルは、ブラウザが実行する最も高 | --------------------------- | ------------------ | | [Starlight][sl-carbon] | 0.01g | | [VitePress][vp-carbon] | 0.05g | +| [Docus][dc-carbon] | 0.05g | | [Sphinx][sx-carbon] | 0.07g | | [MkDocs][mk-carbon] | 0.10g | | [Nextra][nx-carbon] | 0.11g | +| [docsify][dy-carbon] | 0.11g | | [Docusaurus][ds-carbon] | 0.24g | | [Read the Docs][rtd-carbon] | 0.24g | | [GitBook][gb-carbon] | 0.71g | @@ -87,9 +89,11 @@ JavaScriptの解析とコンパイルは、ブラウザが実行する最も高 [sl-carbon]: https://www.websitecarbon.com/website/starlight-astro-build-getting-started/ [vp-carbon]: https://www.websitecarbon.com/website/vitepress-dev-guide-what-is-vitepress/ +[dc-carbon]: https://www.websitecarbon.com/website/docus-dev-introduction-getting-started/ [sx-carbon]: https://www.websitecarbon.com/website/sphinx-doc-org-en-master-usage-quickstart-html/ [mk-carbon]: https://www.websitecarbon.com/website/mkdocs-org-getting-started/ [nx-carbon]: https://www.websitecarbon.com/website/nextra-site-docs-docs-theme-start/ +[dy-carbon]: https://www.websitecarbon.com/website/docsify-js-org/ [ds-carbon]: https://www.websitecarbon.com/website/docusaurus-io-docs/ [rtd-carbon]: https://www.websitecarbon.com/website/docs-readthedocs-io-en-stable-index-html/ [gb-carbon]: https://www.websitecarbon.com/website/docs-gitbook-com/ @@ -99,6 +103,7 @@ JavaScriptの解析とコンパイルは、ブラウザが実行する最も高 ### ツール - [Website Carbon Calculator][wcc] +- [GreenFrame](https://greenframe.io/) - [Ecograder](https://ecograder.com/) - [WebPageTest Carbon Control](https://www.webpagetest.org/carbon-control/) - [Ecoping](https://ecoping.earth/) diff --git a/docs/src/content/docs/ja/getting-started.mdx b/docs/src/content/docs/ja/getting-started.mdx index 23fc7d0b..ec4e76e1 100644 --- a/docs/src/content/docs/ja/getting-started.mdx +++ b/docs/src/content/docs/ja/getting-started.mdx @@ -60,9 +60,9 @@ Starlightでは、MarkdownとMDXでコンテンツを作成できます。（Mar `src/content/docs/`に`.md`または`.mdx`ファイルを作成して、サイトに新しいページを自動で追加できます。ファイルを整理するためにサブフォルダを追加し、複数のパスセグメントを作成することもできます。 -```js -`src/content/docs/hello-world.md` -> `your-site/hello-world` -`src/content/docs/guides/faq.md` -> `your-site/guides/faq` +``` +src/content/docs/hello-world.md => your-site.com/hello-world +src/content/docs/guides/faq.md => your-site.com/guides/faq ``` ### 型安全なフロントマター diff --git a/docs/src/content/docs/ja/guides/authoring-content.md b/docs/src/content/docs/ja/guides/authoring-content.md index e652c42f..8d603bc2 100644 --- a/docs/src/content/docs/ja/guides/authoring-content.md +++ b/docs/src/content/docs/ja/guides/authoring-content.md @@ -44,7 +44,7 @@ MarkdownとMDXは、スクリーンリーダーや支援技術のための代替 ```md // src/content/docs/page-1.md -![宇宙空間に浮かぶロケット。](../../assets/images/rocket.svg) +![宇宙空間に浮かぶロケット](../../assets/images/rocket.svg) ``` diff --git a/docs/src/content/docs/reference/configuration.md b/docs/src/content/docs/reference/configuration.md index 88db44cf..b2cac362 100644 --- a/docs/src/content/docs/reference/configuration.md +++ b/docs/src/content/docs/reference/configuration.md @@ -5,7 +5,7 @@ description: An overview of all the configuration options Starlight supports. ## Configure the `starlight` integration -Starlight is an integration built on top the [Astro](https://astro.build) web framework. You can configure your project inside the Astro `astro.config.mjs` configuration file: +Starlight is an integration built on top the [Astro](https://astro.build) web framework. You can configure your project inside the `astro.config.mjs` configuration file: ```js // astro.config.mjs @@ -15,7 +15,7 @@ import starlight from '@astrojs/starlight'; export default defineConfig({ integrations: [ starlight({ - title: "My delightful docs site", + title: 'My delightful docs site', }), ], }); -- cgit