Skip to content

Commit 3de4c7a

Browse files
committed
Start bootstrapping docs
1 parent a04375f commit 3de4c7a

23 files changed

+140
-1623
lines changed

.github/workflows/unit-test.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ jobs:
2626
run: pnpm install
2727

2828
- name: Build
29-
run: pnpm run build
29+
run: pnpm -r run build
3030

3131
- name: Lint
32-
run: pnpm run lint
32+
run: pnpm -r run lint
3333

3434
- name: Typecheck
35-
run: pnpm run typecheck
35+
run: pnpm -r run typecheck
3636

3737
- name: Test
38-
run: pnpm run test
38+
run: pnpm -r run test

.gitignore

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,21 @@ dist
33
*.log
44
.DS_Store
55
.eslintcache
6-
coverage
6+
coverage
7+
.output
8+
.data
9+
.nuxt
10+
.nitro
11+
.cache
12+
logs
13+
.fleet
14+
.idea
15+
.env
16+
.env.*
17+
!.env.example
18+
*.tgz
19+
.tmp
20+
.profile
21+
*.0x
22+
.history
23+
.wrangler

docs/.gitignore

Lines changed: 0 additions & 37 deletions
This file was deleted.

docs/README.md

Lines changed: 0 additions & 72 deletions
This file was deleted.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Installation
3+
description: Get started with Vue Split Panel.
4+
navigation:
5+
icon: i-lucide-download
6+
seo:
7+
description: Get started with Vue Split Panel.
8+
---
9+
10+
::steps
11+
### Install the package
12+
13+
```bash [Terminal]
14+
pnpm add @directus/vue-split-panel
15+
```
16+
17+
### Import and use the SplitPanel component
18+
19+
```vue [MyComponent.vue]
20+
<script lang="ts" setup>
21+
import { SplitPanel } from '@directus/vue-split-panel';
22+
</script>
23+
24+
<template>
25+
<SplitPanel>
26+
<template #start>
27+
<p>Panel A</p>
28+
</template>
29+
30+
<template #end>
31+
<p>Panel B</p>
32+
</template>
33+
</SplitPanel>
34+
</template>
35+
```
36+
::

docs/content/1.getting-started/2.introduction.md

Lines changed: 0 additions & 54 deletions
This file was deleted.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Usage
3+
description: All usage options available in Vue Split Panel
4+
navigation:
5+
icon: i-lucide-align-horizontal-justify-center
6+
---
7+

docs/content/1.getting-started/3.contributing.md

Whitespace-only changes.

docs/content/1.getting-started/3.installation.md

Lines changed: 0 additions & 65 deletions
This file was deleted.

docs/content/1.getting-started/4.project-structure.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

0 commit comments

Comments
 (0)