Skip to content

Commit c4dcafe

Browse files
committed
docs(update): update content
1 parent a5add5c commit c4dcafe

File tree

4 files changed

+29
-21
lines changed

4 files changed

+29
-21
lines changed

docs/src/components/content-container.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,21 @@ If set, the heading is rendered as an abstract heading. (e.g. `<slot />`)
2626
- Type: `String`
2727
- Default: `null`
2828

29-
The tag for the element.
29+
Tag for the element.
3030

3131
### contentTags
3232

3333
- Type: `Array`
3434
- Default: `['section', 'article']`
3535

36-
The available tags for the content structure.
36+
Available tags for the content structure.
3737

3838
### rootTags
3939

4040
- Type: `Array`
4141
- Default: `['main', null]`
4242

43-
The available tags for the root structure.
43+
Available tags for the root structure.
4444

4545
### level
4646

docs/src/components/content-headline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If set, the heading is rendered as an abstract heading. (e.g. `<slot />`)
2828
- Type: `String`
2929
- Default: `null`
3030

31-
The tag for the element.
31+
Tag for the element.
3232

3333
## Example
3434

docs/src/composables/use-content-container.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
# useContentContainer
22

3+
## Introduction
4+
35
::: tip
4-
Optional kann auch die Komponente [`<ContentContainer>`](../components/content-container) als Wrapper verwendet werden.
6+
Optionally, the component [`<ContentContainer>`](../components/content-container) can also be used as a wrapper.
57
:::
68

7-
Das Composable `useContentContainer` wird eingesetzt um die Tiefe der Seitenstruktur abzubilden.
9+
The composable `useContentContainer` is used to map the depth of the page structure.
10+
11+
With each call of `useContentContainer()` in nested components, the level of the page structure is increased by one level (`level`).
812

9-
Mit jedem aufruf von `useContentContainer()` in verschachtelten Komponenten wird die steigt das Level der Seitenstruktur um eine Ebene (`level`).
13+
The appropriate HTML element for the page structure is determined based on the `level`. (e.g. `main`, `section`, `article`)
1014

11-
Anhand des `level` wird das passende HTML-Element für die Seitenstruktur ermittelt. (e.g. `main`, `section`, `article`)
15+
Translated with DeepL.com (free version)
1216

1317
```vue
1418
<template>
@@ -28,12 +32,12 @@ const { currentTag } = useContentContainer()
2832

2933
## Options
3034

31-
| Property | Type | Description | Default Value |
32-
| ------------- | -------- | -------------------------------------------------------- | ------------------------ |
33-
| `tag` | `String` | Der Tag für das HTML-Element. Optional zu überschreiben. | `undefined` |
34-
| `contentTags` | `Array` | Die möglichen contentTags für das HTML-Element. | `['section', 'article']` |
35-
| `rootTags` | `Array` | Die möglichen Tag-Strukturen für das HTML-Element. | `['main', undefined]` |
36-
| `level` | `Number` | Der Level für das HTML-Element. | `undefined` |
35+
| Property | Type | Description | Default Value |
36+
| ------------- | -------- | ----------------------------------------- | ------------------------ |
37+
| `tag` | `String` | Can be used to overwrite the tag. | `undefined` |
38+
| `contentTags` | `Array` | Available tags for the content structure. | `['section', 'article']` |
39+
| `rootTags` | `Array` | Available tags for the root structure. | `['main', undefined]` |
40+
| `level` | `Number` | Can be used to overwrite the level. | `undefined` |
3741

3842
## Return
3943

docs/src/composables/use-content-headline.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
# useContentContainer
22

3+
## Introduction
4+
35
::: tip
4-
Optional kann auch die Komponente [`<ContentHeadline>`](../components/content-headline) als Wrapper verwendet werden.
6+
Optionally, the component [`<ContentHeadline>`](../components/content-headline) can also be used as a wrapper.
57
:::
68

7-
Das Composable `useContentContainer` wird eingesetzt um die Tiefe der Seitenstruktur abzubilden.
9+
`useContentHEadline()` is used to display the headline structure.
10+
11+
Example: `h1`, `h2`, `h3`, `h4`, `h5`, `h6`
812

9-
Mit jedem aufruf von `useContentContainer()` in verschachtelten Komponenten wird die steigt das Level der Seitenstruktur um eine Ebene (`level`).
13+
The level of the heading is taken from `useContentContainer()` or `ContentContainer`.
1014

11-
Anhand des `level` wird das passende HTML-Element für die Seitenstruktur ermittelt. (e.g. `main`, `section`, `article`)
15+
The deeper the nesting, the smaller the heading.
1216

1317
```vue
1418
<template>
@@ -27,9 +31,9 @@ const { currentTag } = useContentHeadline()
2731

2832
## Options
2933

30-
| Property | Type | Description | Default Value |
31-
| -------- | -------- | ------------------------------ | ------------- |
32-
| `tag` | `String` | DDer Tag für das HTML-Element. | `undefined` |
34+
| Property | Type | Description | Default Value |
35+
| -------- | -------- | ------------------- | ------------- |
36+
| `tag` | `String` | Tag for the element | `undefined` |
3337

3438
## Return
3539

0 commit comments

Comments
 (0)