Skip to content

Commit 70aec3d

Browse files
committed
fix(docs): add Definitions section and update navigation
1 parent 0612e3d commit 70aec3d

File tree

3 files changed

+105
-9
lines changed

3 files changed

+105
-9
lines changed

docs/.vitepress/navigation.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ export default {
1111
items: [
1212
{ text: 'Introduction', link: '/introduction' },
1313
{ text: 'Setup', link: '/setup' },
14-
{ text: 'Usage', link: '/usage' }
14+
{ text: 'Usage', link: '/usage' },
15+
{ text: 'Definitions', link: '/definitions' }
1516
]
1617
},
1718
{

docs/src/definitions.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
title: Definitions
3+
---
4+
5+
# {{$frontmatter.title}}
6+
7+
All listed definitions are available in the `vue-semantic-structure` package.
8+
9+
### Example
10+
11+
```ts
12+
import type { ContentContainerProps } from 'vue-semantic-structure';
13+
```
14+
15+
## Interface
16+
17+
### ContentContainerProps
18+
19+
```ts
20+
interface ContentContainerProps {
21+
tag?: string;
22+
rootTags?: string[];
23+
contentTags?: string[];
24+
level?: number;
25+
debug?: boolean;
26+
}
27+
```
28+
29+
### ContentContainerContext
30+
31+
```ts
32+
interface ContentContainerContext extends ContentContainerProps {
33+
parentLevel: number;
34+
currentLevel: number;
35+
currentTag: string;
36+
}
37+
```
38+
39+
### ContentHeadlineProps
40+
41+
```ts
42+
interface ContentHeadlineProps {
43+
tag: string;
44+
debug: boolean;
45+
}
46+
```
47+
48+
### ContentHeadlineContext
49+
50+
```ts
51+
interface ContentHeadlineContext extends ContentHeadlineProps {
52+
parentLevel: number;
53+
currentLevel: number;
54+
currentTag: string;
55+
}
56+
```
57+
58+
### ContentContainerOptions
59+
60+
```ts
61+
interface ContentContainerOptions {
62+
tag?: string | undefined;
63+
rootTags?: string[];
64+
contentTags?: string[];
65+
level?: number;
66+
}
67+
```
68+
69+
### ContentContainerReturn
70+
71+
```ts
72+
interface ContentContainerReturn {
73+
parentLevel: ComputedRef<number>;
74+
currentLevel: ComputedRef<number>;
75+
currentTag: ComputedRef<string>;
76+
}
77+
```
78+
79+
### ContentHeadlineOptions
80+
81+
```ts
82+
interface ContentHeadlineOptions {
83+
tag?: string | undefined;
84+
}
85+
```
86+
87+
### ContentHeadlineReturn
88+
89+
```ts
90+
interface ContentHeadlineReturn {
91+
parentLevel: ComputedRef<number>;
92+
currentLevel: ComputedRef<number>;
93+
currentTag: ComputedRef<string>;
94+
}
95+
```

src/index.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
export { default as ContentContainer } from './ContentContainer';
2-
export { default as ContentHeadline } from './ContentHeadline';
1+
export * from './ContentContainer';
2+
export * from './ContentHeadline';
33

4-
export type { ContentHeadlineProps, ContentHeadlineContext } from './ContentHeadline';
5-
export type { ContentContainerProps, ContentContainerContext } from './ContentContainer';
4+
export type * from './ContentHeadline';
5+
export type * from './ContentContainer';
66

7-
export { default as useContentContainer } from './useContentContainer';
8-
export { default as useContentHeadline } from './useContentHeadline';
7+
export * from './useContentContainer';
8+
export * from './useContentHeadline';
99

10-
export type { ContentContainerOptions, ContentContainerReturn } from './useContentContainer';
11-
export type { ContentHeadlineOptions, ContentHeadlineReturn } from './useContentHeadline';
10+
export type * from './useContentContainer';
11+
export type * from './useContentHeadline';

0 commit comments

Comments
 (0)