Skip to content

Commit 4cee2c5

Browse files
committed
docs(vitepress): Add additional documentation files
1 parent e542632 commit 4cee2c5

File tree

7 files changed

+21
-24
lines changed

7 files changed

+21
-24
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
- run: pnpm docs:build
2323

2424
- name: Deploy
25-
uses: peaceiris/actions-gh-pages@v3
25+
uses: peaceiris/actions-gh-pages@v4
2626
with:
2727
github_token: ${{ secrets.GITHUB_TOKEN }}
2828
publish_dir: docs/.vitepress/dist

docs/advanced/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ Schema- and Repeater-related composables are provided to simplify the usage of t
77

88
## Nuxt
99

10-
Nuxt Module is available.
10+
Nuxt Module is available.

docs/advanced/nuxt.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,9 @@ npx nuxi module add @sfxcode/formkit-primevue-nuxt
2121

2222
That's it! You can now use FormKit PrimeVue Nuxt Module in your Nuxt app ✨
2323

24-
2524
### Module Options
2625

2726
- **includePrimeIcons** (default: `true`): Add PrimeIcons CSS to the project.
2827
- **includeStyles** (default: `true`): Add custom FormKit CSS to the project.
2928
- **installI18N** (default: `true`): Install nuxt i18n module automatically.
30-
- **installFormKit** (default: `true`): Install nuxt formkit module automatically.
29+
- **installFormKit** (default: `true`): Install nuxt formkit module automatically.

docs/advanced/plugins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ To use the AsteriskPlugin, you need to import it and add it to your FormKit conf
1313

1414
```ts
1515
plugins: [
16-
addPrimeAsteriskPlugin,
16+
addPrimeAsteriskPlugin,
1717
]
18-
```
18+
```

docs/guide/form.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ For the simple usage with schema and data values FormKitDataEdit and FormKitData
44

55
<DisplayFormComponents />
66

7-
87
## Usage
98

109
To use the components there must be an import or global registration.
1110

12-
```ts
13-
<FormKitDataEdit v-model="formData" :schema="formSchema"
14-
@data-saved="submitHandler"/>
11+
```vue
12+
<FormKitDataEdit v-model="formData" :schema="formSchema"
13+
@data-saved="submitHandler"
14+
/>
1515
```
1616

1717
### Debug
@@ -22,7 +22,7 @@ Use properties **:debug-schema="true"** and / or **:debug-data="true"** for debu
2222

2323
### Main Properties
2424

25-
| Property | Type | Description
25+
| Property | Type | Description
2626
|:--------------| :-------- |:--------------------------------------------------------|
2727
| v-model | Object | The data object to be edited with 2-Way-Binding |
2828
| data | Object | The data object to be edited |
@@ -32,7 +32,7 @@ Use properties **:debug-schema="true"** and / or **:debug-data="true"** for debu
3232
| :show-reset | Boolean | Display some Button for resetting data to initial state |
3333
### Style Properties
3434

35-
| Property | Type | Description
35+
| Property | Type | Description
3636
|:---------------|:--------|:--------------------------------------------|
3737
| formClass | String | Add additional classes to the form |
3838
| actionsClass | String | Add additional classes to the action div |
@@ -45,7 +45,6 @@ Use properties **:debug-schema="true"** and / or **:debug-data="true"** for debu
4545
| resetLabel | String | Default: Reset |
4646
| resetIcon | String | PrimeVue Button icon |
4747

48-
4948
### Example
5049

5150
```vue
@@ -62,7 +61,8 @@ async function submitHandler(data: any) {
6261
6362
<template>
6463
<div>
65-
<FormKitDataEdit v-model="formData" :schema="formSchema"
64+
<FormKitDataEdit
65+
v-model="formData" :schema="formSchema"
6666
:debug-schema="false" :debug-data="true"
6767
@data-saved="submitHandler"
6868
/>

docs/guide/getting-started.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,5 +139,3 @@ async function submitHandler() {
139139
</div>
140140
</template>
141141
```
142-
143-

pnpm-lock.yaml

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)