From e282e8e4ac7077a43b48bd692cfa28bbe4a9bdd0 Mon Sep 17 00:00:00 2001 From: "Fred K. Schott" Date: Fri, 3 Sep 2021 11:06:25 -0700 Subject: Add new component, to succeed (#1208) * add code component * Update packages/astro/components/Debug.astro Co-authored-by: Caleb Jasik * Update packages/astro/components/Debug.astro Co-authored-by: Caleb Jasik * fix format in debug component * remove Debug changes * add wrap support * add props docs * update default theme Co-authored-by: Peter Singh Co-authored-by: Caleb Jasik --- docs/src/pages/bg/getting-started.md | 2 +- docs/src/pages/de/getting-started.md | 2 +- docs/src/pages/es/getting-started.md | 2 +- docs/src/pages/fi/getting-started.md | 2 +- docs/src/pages/fr/getting-started.md | 2 +- docs/src/pages/getting-started.md | 2 +- docs/src/pages/nl/getting-started.md | 2 +- docs/src/pages/pt-br/getting-started.md | 2 +- docs/src/pages/reference/builtin-components.md | 20 ++++++++++++++++++++ docs/src/pages/zh-CN/getting-started.md | 2 +- docs/src/pages/zh-TW/getting-started.md | 2 +- 11 files changed, 30 insertions(+), 10 deletions(-) (limited to 'docs/src') diff --git a/docs/src/pages/bg/getting-started.md b/docs/src/pages/bg/getting-started.md index 8b4c16bfc..003dc3424 100644 --- a/docs/src/pages/bg/getting-started.md +++ b/docs/src/pages/bg/getting-started.md @@ -39,7 +39,7 @@ _Бележка: някои функционалности (например: Fa ### API Справка -Тази секция е полезна, когато искате да научите повече детайли относно даден Astro API. Например - [Конфигурационната справка](/reference/configuration-reference) изброява всички възможни конфигурационни опции. [Справката за вградени компоненти](/reference/builtin-components) изброява всички възможни базови (core) компоненти, като `` и ``. +Тази секция е полезна, когато искате да научите повече детайли относно даден Astro API. Например - [Конфигурационната справка](/reference/configuration-reference) изброява всички възможни конфигурационни опции. [Справката за вградени компоненти](/reference/builtin-components) изброява всички възможни базови (core) компоненти, като `` и ``. ### Версия на документацията diff --git a/docs/src/pages/de/getting-started.md b/docs/src/pages/de/getting-started.md index 1ebd1846c..928982cf9 100644 --- a/docs/src/pages/de/getting-started.md +++ b/docs/src/pages/de/getting-started.md @@ -44,7 +44,7 @@ Unsere Anleitung zu [Astro-Komponenten](/core-concepts/astro-components) sollte Dieser Dokumentationsabschnitt sollte für Dich nützlich sein, wenn Du mehr Details über eine bestimme Astro-API erfahren möchtest. -So listet z.B. die [Konfigurationsdokumentation](/reference/configuration-reference) alle möglichen Konfigurationseigenschaften auf, die Dir zur Verfügung stehen. In der [Dokumentation über eingebaute Komponenten](/reference/builtin-components) findest Du alle verfügbaren Kernkomponenten wie `` und ``. +So listet z.B. die [Konfigurationsdokumentation](/reference/configuration-reference) alle möglichen Konfigurationseigenschaften auf, die Dir zur Verfügung stehen. In der [Dokumentation über eingebaute Komponenten](/reference/builtin-components) findest Du alle verfügbaren Kernkomponenten wie `` und ``. ### Versionierte Dokumentation diff --git a/docs/src/pages/es/getting-started.md b/docs/src/pages/es/getting-started.md index 31b53f9bc..5de120149 100644 --- a/docs/src/pages/es/getting-started.md +++ b/docs/src/pages/es/getting-started.md @@ -39,7 +39,7 @@ Nuestra guía sobre [componentes Astro](https://docs.astro.build/core-concepts/a ### Referencia de la API -Esta sección de documentación es útil cuando deseas obtener más detalles sobre una API de Astro en particular. Por ejemplo, la [referencia de configuración](https://docs.astro.build/reference/configuration-reference) enumera todas las opciones de configuración disponibles. La [referencia de componentes incluidos](https://docs.astro.build/reference/builtin-components) enumera todos los componentes básicos disponibles, como `` y ``. +Esta sección de documentación es útil cuando deseas obtener más detalles sobre una API de Astro en particular. Por ejemplo, la [referencia de configuración](https://docs.astro.build/reference/configuration-reference) enumera todas las opciones de configuración disponibles. La [referencia de componentes incluidos](https://docs.astro.build/reference/builtin-components) enumera todos los componentes básicos disponibles, como `` y ``. ### Documentación versionada diff --git a/docs/src/pages/fi/getting-started.md b/docs/src/pages/fi/getting-started.md index f7694e436..df6f76432 100644 --- a/docs/src/pages/fi/getting-started.md +++ b/docs/src/pages/fi/getting-started.md @@ -37,7 +37,7 @@ Oppaamme [Astron komponenteista](/core-concepts/astro-components) esittelee uude ### API-luettelo -Tämä dokumentaation osa on hyödyllisin halutessasi oppia yksityiskohtia tietystä Astron rajapinnasta. Muun muassa [asetusluettelo](/reference/configuration-reference) listaa kaikki mahdolliset asetusvaihtoehdot. [Ydinkomponenttien luettelo](/reference/builtin-components) listaa kaikki käytössä olevat Astron mukana tulevat komponentit kuten `` ja ``. +Tämä dokumentaation osa on hyödyllisin halutessasi oppia yksityiskohtia tietystä Astron rajapinnasta. Muun muassa [asetusluettelo](/reference/configuration-reference) listaa kaikki mahdolliset asetusvaihtoehdot. [Ydinkomponenttien luettelo](/reference/builtin-components) listaa kaikki käytössä olevat Astron mukana tulevat komponentit kuten `` ja ``. ### Dokumentaation versioinnista diff --git a/docs/src/pages/fr/getting-started.md b/docs/src/pages/fr/getting-started.md index 94773be10..1bb713b34 100644 --- a/docs/src/pages/fr/getting-started.md +++ b/docs/src/pages/fr/getting-started.md @@ -39,7 +39,7 @@ Notre guide sur les [composants Astro](/core-concepts/astro-components) vous pr ### Documentation de l'API -Cette documentation vous sera utile si vous souhaitez comprendre en détails certaines API d'Astro. Par exemple, la [Documentation de la Configuration](/reference/configuration-reference) liste toutes les options de configuration à votre disposition. La [Documentation des Composants de base](/reference/builtin-components) liste tous les composants disponibles de base, comme `` et ``. +Cette documentation vous sera utile si vous souhaitez comprendre en détails certaines API d'Astro. Par exemple, la [Documentation de la Configuration](/reference/configuration-reference) liste toutes les options de configuration à votre disposition. La [Documentation des Composants de base](/reference/builtin-components) liste tous les composants disponibles de base, comme `` et ``. ### Documentation versionnée diff --git a/docs/src/pages/getting-started.md b/docs/src/pages/getting-started.md index b1d1563f5..73ac8e0d7 100644 --- a/docs/src/pages/getting-started.md +++ b/docs/src/pages/getting-started.md @@ -38,7 +38,7 @@ Our helpful guide on [Astro components](/core-concepts/astro-components) introdu ### API Reference -This documentation section is useful when you want to learn more details about a particular Astro API. For example, [Configuration Reference](/reference/configuration-reference) lists all possible configuration options available to you. [Built-in Components Reference](/reference/builtin-components) lists all available core components, like `` and ``. +This documentation section is useful when you want to learn more details about a particular Astro API. For example, [Configuration Reference](/reference/configuration-reference) lists all possible configuration options available to you. [Built-in Components Reference](/reference/builtin-components) lists all available core components, like `` and ``. ### Versioned Documentation diff --git a/docs/src/pages/nl/getting-started.md b/docs/src/pages/nl/getting-started.md index 66fa7e8c5..e02742710 100644 --- a/docs/src/pages/nl/getting-started.md +++ b/docs/src/pages/nl/getting-started.md @@ -37,7 +37,7 @@ Onze gids over [Astro-componenten](/core-concepts/astro-components) helpt je doo ### API referentie -Deze documentatiesectie is handig als je meer details wilt weten over een bepaalde Astro API. [Configuratie referentie](/reference/configuration-reference) vermeldt bijvoorbeeld alle mogelijke configuratieopties die beschikbaar zijn. [Ingebouwde Componenten Referentie](/reference/builtin-components) geeft een overzicht van alle beschikbare kerncomponenten, zoals en . +Deze documentatiesectie is handig als je meer details wilt weten over een bepaalde Astro API. [Configuratie referentie](/reference/configuration-reference) vermeldt bijvoorbeeld alle mogelijke configuratieopties die beschikbaar zijn. [Ingebouwde Componenten Referentie](/reference/builtin-components) geeft een overzicht van alle beschikbare kerncomponenten, zoals en . ### Documentatie versies diff --git a/docs/src/pages/pt-br/getting-started.md b/docs/src/pages/pt-br/getting-started.md index 36bb910dd..d4b2cc661 100644 --- a/docs/src/pages/pt-br/getting-started.md +++ b/docs/src/pages/pt-br/getting-started.md @@ -39,7 +39,7 @@ Nosso guia útil em [componentes Astro](/core-concepts/astro-components) apresen ### Referência da API -Esta seção de documentação é útil quando você deseja aprender mais detalhes sobre uma determinada API do Astro. Por exemplo, [Referência de Configuração](/reference/configuration-reference) lista todas as opções de configuração possíveis disponíveis para você. [Referência de componentes incorporados](/reference/builtin-components) listas todos os componentes base disponíveis, como `` e ``.s +Esta seção de documentação é útil quando você deseja aprender mais detalhes sobre uma determinada API do Astro. Por exemplo, [Referência de Configuração](/reference/configuration-reference) lista todas as opções de configuração possíveis disponíveis para você. [Referência de componentes incorporados](/reference/builtin-components) listas todos os componentes base disponíveis, como `` e ``.s ### Documentação por Versão diff --git a/docs/src/pages/reference/builtin-components.md b/docs/src/pages/reference/builtin-components.md index 3db33e0db..7ff0e5ba6 100644 --- a/docs/src/pages/reference/builtin-components.md +++ b/docs/src/pages/reference/builtin-components.md @@ -5,6 +5,26 @@ title: Built-In Components Astro includes several builtin components for you to use in your projects. All builtin components are available via `import {} from 'astro/components';`. + +## `` + +```astro +--- +import { Code } from 'astro/components'; +--- + + + + + + +``` + +This component provides syntax highlighting for code blocks at build time (no client-side JavaScript included). The component is powered internally by shiki and it supports all popular [themes](https://github.com/shikijs/shiki/blob/main/docs/themes.md) and [languages](https://github.com/shikijs/shiki/blob/main/docs/languages.md). + +You can also use the `` component for syntax highlighting powered by the [Prism](https://prismjs.com/) syntax highlighting library. This is the library that Astro's Markdown uses by default. However, we will be transitioning all usage over to `` as we move towards our v1.0 release. + + ## `` ```astro diff --git a/docs/src/pages/zh-CN/getting-started.md b/docs/src/pages/zh-CN/getting-started.md index c602f928b..e50be90d4 100644 --- a/docs/src/pages/zh-CN/getting-started.md +++ b/docs/src/pages/zh-CN/getting-started.md @@ -40,7 +40,7 @@ Astro 是一个现代的静态网站生成工具. 你可以从 [我们的主页] ### API 参考文档 -当你想了解某个特定的 Astro API 的更多细节时，这部分文档是有用的。例如 [配置参考](/reference/configuration-reference) 列出所有可能的配置选项供你使用。 [内置组件参考](/reference/builtin-components) 列出了所有可用的核心组件，如``和``。 +当你想了解某个特定的 Astro API 的更多细节时，这部分文档是有用的。例如 [配置参考](/reference/configuration-reference) 列出所有可能的配置选项供你使用。 [内置组件参考](/reference/builtin-components) 列出了所有可用的核心组件，如``和``。 ### 其他版本文档 diff --git a/docs/src/pages/zh-TW/getting-started.md b/docs/src/pages/zh-TW/getting-started.md index 10bfc9270..ef1d2dc91 100644 --- a/docs/src/pages/zh-TW/getting-started.md +++ b/docs/src/pages/zh-TW/getting-started.md @@ -39,7 +39,7 @@ Astro 是利用現代技術的靜態網站生成工具。可以從[首頁](https ### API 參考手冊 -如果想要深入探討某個 Astro API，這部分的文件會很有幫助。例如：[設定參考](/reference/configuration-reference)列出所有可以使用的設定選項。[內建元件參考](/reference/builtin-components)列出所有可以使用的核心元件，像是 `` 和 ``。 +如果想要深入探討某個 Astro API，這部分的文件會很有幫助。例如：[設定參考](/reference/configuration-reference)列出所有可以使用的設定選項。[內建元件參考](/reference/builtin-components)列出所有可以使用的核心元件，像是 `` 和 ``。 ### 先前版本的文件 -- cgit v1.2.3