Skip to content

Commit

Permalink
Merge pull request #6 from basics/feature/init
Browse files Browse the repository at this point in the history
update
  • Loading branch information
ThornWalli authored Sep 23, 2024
2 parents 3b2afb5 + ccca19c commit 163ee7c
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 3 deletions.
7 changes: 5 additions & 2 deletions docs/.vitepress/navigation.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@ export default {
nav: [
{ text: 'Home', link: '/' },
{ text: 'Introduction', link: '/introduction' },
{ text: 'Live Example', link: '/example/' }
{ text: 'Live Example', link: '/playground/' }
],

sidebar: [
{
text: 'Guide',
items: [{ text: 'Introduction', link: '/introduction' }]
items: [
{ text: 'Introduction', link: '/introduction' },
{ text: 'Setup', link: '/setup' }
]
},
{
text: 'Composables',
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ hero:
link: /introduction
- theme: alt
text: Live Example
link: /example/
link: /playground/

features:
- title: Heading
Expand Down
39 changes: 39 additions & 0 deletions docs/src/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Setup
---

# {{$frontmatter.title}}

## Installation

Install `vue-semantic-structure` as a dependency to your project:

::: code-group

```bash [Yarn]
yarn add vue-semantic-structure
```

```bash [NPM]
npm install vue-semantic-structure
```

```bash [PNPM]
pnpm add vue-semantic-structure
```

:::

## Usage

You can find uses in the following sections:

**Components**

- [ContentContainer](/components/content-container)
- [ContentHeadline](/components/content-headline)

**Composables:**

- [useContentContainer](/composables/use-content-container)
- [useContentHeadline](/composables/use-content-headline)
6 changes: 6 additions & 0 deletions playground/vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ const __dirname = dirname(fileURLToPath(import.meta.url));

// https://vitejs.dev/config/
export default defineConfig({
base: getBaseUrl(),

plugins: [vue()],

server: {
Expand All @@ -21,3 +23,7 @@ export default defineConfig({
}
}
});

function getBaseUrl() {
return process.env.npm_config_base_url || process.env.BASE_URL || '/';
}

0 comments on commit 163ee7c

Please sign in to comment.