Skip to content

Commit

Permalink
Merge branch 'main' into chris/locals-route-data
Browse files Browse the repository at this point in the history
  • Loading branch information
delucis authored Oct 19, 2024
2 parents 286e9c8 + 46d53aa commit 34129ab
Show file tree
Hide file tree
Showing 128 changed files with 11,673 additions and 756 deletions.
5 changes: 0 additions & 5 deletions .changeset/quick-swans-rule.md

This file was deleted.

3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
- What does this PR change? Give us a brief description.
- Did you change something visual? A before/after screenshot can be helpful.

<!-- TAKING PART IN HACKTOBERFEST? LET US KNOW! -->
<!-- See https://contribute.docs.astro.build/guides/hacktoberfest/ for more details. -->

<!--
Here’s what will happen next:
One or more of our maintainers will take a look and may ask you to make changes.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ jobs:

pa11y:
name: Check for accessibility issues
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down
7 changes: 7 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,13 @@ export default defineConfig({
{
label: 'Components',
translations: {
de: 'Komponenten',
fr: 'Composants',
ru: 'Компоненты',
ko: '컴포넌트',
ja: 'コンポーネント',
'zh-CN': '组件',
uk: 'Компоненти',
},
autogenerate: { directory: 'components' },
},
Expand All @@ -161,13 +166,15 @@ export default defineConfig({
{
label: 'Resources',
translations: {
de: 'Ressourcen',
'zh-CN': '资源',
fr: 'Ressources',
'pt-BR': 'Recursos',
'pt-PT': 'Recursos',
ja: 'リソース',
ru: 'Ресурсы',
ko: '리소스',
uk: 'Ресурси',
},
autogenerate: { directory: 'resources' },
},
Expand Down
3 changes: 2 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"start": "astro dev",
"build": "astro build",
"preview": "astro preview",
"typecheck": "tsc --noEmit",
"astro": "astro",
"lunaria:build": "lunaria build",
"grammars": "node grammars/generate.mjs"
Expand All @@ -25,7 +26,7 @@
},
"devDependencies": {
"pa11y-ci": "^3.0.1",
"starlight-links-validator": "^0.11.0",
"starlight-links-validator": "^0.12.1",
"start-server-and-test": "^2.0.4"
}
}
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 @@ -175,4 +175,9 @@ import FluidGrid from './fluid-grid.astro';
thumbnail="docs.ryzekit.com.png"
/>
<Card title="Open {re}Source" href="https://openresource.dev" thumbnail="openresource.dev.png" />
<Card
title="Orbit CSS"
href="https://zumerlab.github.io/orbit-docs/"
thumbnail="zumerlab.github.io.orbit-docs.png"
/>
</FluidGrid>
2 changes: 1 addition & 1 deletion docs/src/content/docs/components/code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export const highlights = ['file', 'CMS'];

### Display imported code

In MDX files and Astro components, use [Vite’s `?raw` import suffix](https://vitejs.dev/guide/assets#importing-asset-as-string) to import any code file as a string.
In MDX files and Astro components, use [Vite’s `?raw` import suffix](https://vite.dev/guide/assets#importing-asset-as-string) to import any code file as a string.
You can then pass this imported string to the `<Code>` component to include it on your page.

<Preview>
Expand Down
158 changes: 158 additions & 0 deletions docs/src/content/docs/de/components/asides.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
---
title: Nebenbemerkungen
description: Lerne, wie du in Starlight zusätzliche Informationen neben dem Hauptinhalt einer Seite anzeigen kannst.
---

import { Aside } from '@astrojs/starlight/components';

Um sekundäre Informationen neben dem Hauptinhalt einer Seite anzuzeigen, verwende die Komponente `<Aside>`.

import Preview from '~/components/component-preview.astro';

<Preview>

<Aside slot="preview">
Füge nicht wesentliche, ergänzende Informationen in ein `<Aside>`.
</Aside>

</Preview>

## Import

```tsx
import { Aside } from '@astrojs/starlight/components';
```

## Verwendung

Zeige eine Nebenbemerkung (auch bekannt als „Hinweise“, „Ermahnungen“ oder „Aufrufe“) mit Hilfe der Komponente `<Aside>`.

Ein `<Aside>` kann ein optionales [`type`](#type) Attribute haben, welches die Farbe, das Symbol und den Standardtitel der Nebenbemerkung steuert.

<Preview>

````mdx
import { Aside } from '@astrojs/starlight/components';

<Aside>Einige Inhalte am Rande.</Aside>

<Aside type="caution">Einige warnende Inhalte.</Aside>

<Aside type="tip">

Auch andere Inhalte werden durch Nebenbemerkungen unterstützt.

```js
// Ein Codeschnipsel zum Beispiel.
```

</Aside>

<Aside type="danger">Gib dein Passwort nie an Dritte weiter!</Aside>
````

<Fragment slot="markdoc">

````markdoc
{% aside %}
Einige Inhalte am Rande.
{% /aside %}
{% aside type="caution" %}
Einige warnende Inhalte.
{% /aside %}
{% aside type="tip" %}
Auch andere Inhalte werden durch Nebenbemerkungen unterstützt.
```js
// Ein Codeschnipsel zum Beispiel.
```
{% /aside %}
{% aside type="danger" %}
Gib dein Passwort nie an Dritte weiter!
{% /aside %}
````

</Fragment>

<Fragment slot="preview">

<Aside>Einige Inhalte am Rande.</Aside>

<Aside type="caution">Einige warnende Inhalte.</Aside>

<Aside type="tip">

Auch andere Inhalte werden durch Nebenbemerkungen unterstützt.

```js
// Ein Codeschnipsel zum Beispiel.
```

</Aside>

<Aside type="danger">Gib dein Passwort nie an Dritte weiter!</Aside>

</Fragment>

</Preview>

Starlight bietet auch eine benutzerdefinierte Syntax für die Darstellung von Nebenbemerkungen in Markdown und MDX als Alternative zur `<Aside>` Komponente.
Siehe den Leitfaden [„Inhalte in Markdown verfassen“](/de/guides/authoring-content/#nebenbemerkungen) für Details zu dieser Syntax.

### Benutzerdefinierte Titel verwenden

Überschreibe die voreingestellten Überschriften der Nebenbemerkungen mit dem Attribut [`title`](#title).

<Preview>

```mdx 'title="Aufgepasst!"'
import { Aside } from '@astrojs/starlight/components';
<Aside type="caution" title="Aufgepasst!">
Ein Warnhinweis *mit* einem benutzerdefinierten Titel.
</Aside>
```

<Fragment slot="markdoc">

```markdoc 'title="Aufgepasst!"'
{% aside type="caution" title="Aufgepasst!" %}
Ein Warnhinweis *mit* einem benutzerdefinierten Titel.
{% /aside %}
```

</Fragment>

<Aside slot="preview" type="caution" title="Aufgepasst!">
Ein Warnhinweis *mit* einem benutzerdefinierten Titel.
</Aside>

</Preview>

## `<Aside>` Eigenschaften

**Implementation:** [`Aside.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/user-components/Aside.astro)

Die Komponente `<Aside>` akzeptiert die folgenden Eigenschaften:

### `type`

**Typ:** `'note' | 'tip' | 'caution' | 'danger'`
**Voreinstellung:** `'note'`

Die Art der Nebenbemerkung, die angezeigt werden soll:

- `note` Hinweise (die Standardeinstellung) sind blau und zeigen ein Informationssymbol an.
- `tip` Hinweise sind violett und zeigen ein Raketensymbol an.
- `caution` Hinweise sind gelb und zeigen ein dreieckiges Warnsymbol an.
- `danger` Hinweise sind rot und zeigen ein achteckiges Warnsymbol an.

### `title`

**Typ:** `string`

Die Überschrift der anzuzeigenden Nebenbemerkung.
Wenn `title` nicht gesetzt ist, wird der Standardtitel für den aktuellen `type` der Nebenbemerkung verwendet.
Loading

0 comments on commit 34129ab

Please sign in to comment.