Skip to content

Commit

Permalink
docs(update): update playground and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ThornWalli committed Sep 26, 2024
1 parent 35ec551 commit 6904b10
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 4 deletions.
5 changes: 5 additions & 0 deletions docs/src/components/content-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,11 @@ Can be used to overwrite the level.
</ContentContainer>
</ContentContainer>
</template>
<script setup>
import ContentContainer from 'vue-semantic-structure/ContentContainer.vue';
import ContentHeadline from 'vue-semantic-structure/ContentHeadline.vue';
</script>
```

```html
Expand Down
5 changes: 5 additions & 0 deletions docs/src/components/content-headline.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ Tag for the element.
</ContentContainer>
</ContentContainer>
</template>
<script setup>
import ContentContainer from 'vue-semantic-structure/ContentContainer.vue';
import ContentHeadline from 'vue-semantic-structure/ContentHeadline.vue';
</script>
```

```html
Expand Down
5 changes: 5 additions & 0 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ If `ContentContainer` is level 2, `ContentHeadline` level 2 is rendered as `h2`.
<footer>Footer</footer>
</div>
</template>
<script setup>
import ContentContainer from 'vue-semantic-structure/ContentContainer.vue';
import ContentHeadline from 'vue-semantic-structure/ContentHeadline.vue';
</script>
```

```html
Expand Down
10 changes: 9 additions & 1 deletion docs/src/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ The main structure is in the `<main>` tag, which contains the main components.
<ContentContainer class="gallery">…</ContentContainer>
</ContentContainer>
</template>
<script setup>
import ContentContainer from 'vue-semantic-structure/ContentContainer.vue';
</script>
```

```html [HTML]
Expand Down Expand Up @@ -52,7 +56,7 @@ It is recommended to create a separate component that extends the `ContentContai
</template>
<script setup>
import { ContentContainer } from 'vue-semantic-structure';
import ContentContainer from 'vue-semantic-structure/ContentContainer.vue';
</script>
```

Expand All @@ -70,6 +74,10 @@ In comparison to the basic application, the entire content is enclosed in anothe
</CustomContentContainer>
</CustomContentContainer>
</template>
<script setup>
import ContentContainer from 'vue-semantic-structure/ContentContainer.vue';
</script>
```

```html [HTML]
Expand Down
2 changes: 1 addition & 1 deletion playground/src/components/DebugArticleContentContainer.vue
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

<script setup>
import { inject, provide } from 'vue';
import { ContentContainer } from 'vue-semantic-structure';
import ContentContainer from 'vue-semantic-structure/ContentContainer.vue';
const props = defineProps({
debug: {
Expand Down
2 changes: 1 addition & 1 deletion playground/src/components/DebugContainer.vue
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

<script setup>
import { inject, provide } from 'vue';
import { ContentContainer } from 'vue-semantic-structure';
import ContentContainer from 'vue-semantic-structure/ContentContainer.vue';
const props = defineProps({
debug: {
Expand Down
2 changes: 1 addition & 1 deletion playground/src/components/DebugHeadline.vue
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<script setup>
import { inject } from 'vue';
import { ContentHeadline } from 'vue-semantic-structure';
import ContentHeadline from 'vue-semantic-structure/ContentHeadline.vue';
const debug = inject('debugHeadings', false);
</script>

0 comments on commit 6904b10

Please sign in to comment.