Skip to content

Commit

Permalink
[ADD] new doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mathix420 committed Nov 23, 2023
1 parent 9927673 commit b732e92
Show file tree
Hide file tree
Showing 41 changed files with 454 additions and 31,200 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Or via [JsDeliver](https://www.jsdelivr.com/package/npm/vuito?version=latest), [

# Usage

Full documentation ➡️ https://vuito.vercel.app

## Imports

**CJS**
Expand Down Expand Up @@ -77,11 +79,13 @@ signIn.check({

# Vue.js Mixin

> ⚠️ Only supporting Vue2 currently ⚠️
[![minizipped size](https://badgen.net/bundlephobia/minzip/@vuito/vue)](https://bundlephobia.com/result?p=@vuito/vue)

Use vuito with Vue.js or Nuxt.js like a breeze!

[Nuxt.js Demo](https://vuito.vercel.app/demo)
<!-- [Nuxt.js Demo](https://vuito.vercel.app/demo) -->

```bash
npm i @vuito/vue
Expand Down
4 changes: 4 additions & 0 deletions docs/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dist
node_modules
.output
.nuxt
8 changes: 8 additions & 0 deletions docs/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
root: true,
extends: '@nuxt/eslint-config',
rules: {
'vue/max-attributes-per-line': 'off',
'vue/multi-word-component-names': 'off'
}
}
1 change: 1 addition & 0 deletions docs/.gitignore
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ coverage
dist
sw.*
.env
.output
2 changes: 2 additions & 0 deletions docs/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
shamefully-hoist=true
strict-peer-dependencies=false
1 change: 1 addition & 0 deletions docs/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
44 changes: 37 additions & 7 deletions docs/README.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,27 +1,57 @@
# vuito-docs
# Docus Starter

Starter template for [Docus](https://docus.dev).

## Clone

Clone the repository (using `nuxi`):

```bash
npx nuxi init -t themes/docus
```

## Setup

Install dependencies:

```bash
npm run install
yarn install
```

## Development

```bash
npm run dev
yarn dev
```

## Edge Side Rendering

Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments.

Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets).

```bash
yarn build
```

## Static Generation

This will create the `dist/` directory for publishing to static hosting:
Use the `generate` command to build your application.

The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.

```bash
yarn generate
```

## Preview build

You might want to preview the result of your build locally, to do so, run the following command:

```bash
npm run generate
yarn preview
```

To preview the static generated app, run `npm run start`
---

For detailed explanation on how things work, checkout [nuxt/content](https://content.nuxtjs.org) and [@nuxt/content theme docs](https://content.nuxtjs.org/themes-docs).
For a detailed explanation of how things work, check out [Docus](https://docus.dev).
42 changes: 42 additions & 0 deletions docs/app.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
export default defineAppConfig({
docus: {
title: 'Vuito',
description: 'Simple, lightweight, isomorphic, template-based validation library.',
image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png',
socials: {
npm: {
label: 'NPM',
icon: 'simple-icons:npm',
href: 'https://npmjs.com/package/vuito'
},
github: 'mathix420/vuito',
portfolio: {
label: 'Me, Arnaud Gissinger',
icon: 'simple-icons:bento',
href: 'https://bento.me/agissing'
}
},
github: {
dir: 'docs/content',
branch: 'master',
repo: 'vuito',
owner: 'mathix420',
edit: true
},
aside: {
level: 0,
collapsed: false,
exclude: []
},
main: {
padded: true,
fluid: true
},
header: {
logo: true,
showLinkIcon: true,
exclude: [],
fluid: true
}
}
})
Binary file added docs/bun.lockb
Binary file not shown.
96 changes: 0 additions & 96 deletions docs/components/Demo.vue

This file was deleted.

26 changes: 26 additions & 0 deletions docs/components/Logo.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<template>
<svg width="124" height="40" viewBox="0 0 124 40" style="width: 90%; height: 100%;" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M6.325 14.7687C6.325 14.7687 4.6125 15.8469 4.41563 16.9219C4.21875 18 4.6125 19.2719 5.15 20.1031C5.6875 20.9344 6.325 21.6219 7.10938 21.9156C7.89375 22.2094 8.57813 22.1594 8.57813 22.1594C8.57813 22.1594 10.3906 24.2156 13.6188 27.0063C16.8469 29.7969 20.9625 33.125 25.6125 35.7188C30.2625 38.3125 31.9281 38.95 33.2 38.95C34.4719 38.95 34.425 37.0406 34.2781 36.4531C34.1313 35.8656 25.9563 26.7625 25.9563 26.7625L6.325 14.7687Z" fill="#FF8E00" />
<path d="M9.75312 19.5188L8.52813 18.1969C8.52813 18.1969 7.25625 15.7969 6.08125 15.7969C4.90625 15.7969 4.41562 16.9219 4.41562 16.9219C4.41562 16.9219 4.26875 15.6969 5.7375 13.35C7.20625 11.0031 9.06562 9.14063 10.7313 7.96563C12.3969 6.79063 14.45 5.41875 15.8219 4.6375C17.1938 3.85625 20.1781 2.875 21.8938 2.2875C23.6063 1.7 27.3281 0.965627 29.0406 1.30938C30.7531 1.65313 31.4875 2.82813 31.4875 4.05C31.4875 5.27188 31.1938 6.10625 30.95 6.35C30.7063 6.59375 29.0906 7.96563 29.0906 7.96563L9.75312 19.5188Z" fill="#F5B03E" />
<path d="M13.1875 14.3594L10.1531 16.3188L8.88125 18.8156C8.88125 18.8156 9.125 19.6469 9.51875 20.0875C9.90938 20.5281 13.1875 23.6688 15.5344 25.675C17.3656 27.2406 21.2688 30.5625 21.2688 30.5625C21.2688 30.5625 21.4281 32.2313 21.6125 33.4031C21.7594 34.3344 21.7688 35.8875 22.75 35.8438C23.9875 35.7875 23.275 33.2813 24.2563 33.3063C26.2156 33.3563 24.2719 38.6563 26.3781 38.6281C28.0563 38.6063 26.9906 35.7094 27.8313 35.2156C28.2875 34.9469 29.1938 36.0875 30.6719 36.7344C32.4969 37.5313 33.6094 38.1344 34.1969 37.8594C35.4375 37.2781 32.8219 23.725 32.5281 21.425C32.2344 19.125 30.7719 7.3125 30.6719 6.92188C30.5719 6.53125 28.5656 6.48125 28.5656 6.48125L25.4813 7.55938L21.075 8.14688L15.8875 11.2313L13.1875 14.3594Z" fill="#FFCC8A" />
<path d="M12.4219 13.8688C11.4594 14.4125 10.2188 14.7156 9.17188 16.4406C8.3 17.8781 8.06875 19.35 8.69063 19.4625C9.3125 19.575 9.78438 17.4062 10.6125 16.5812C11.9406 15.2531 13.0156 15.1125 13.7781 14.4062C14.5406 13.7 15.375 11.7812 18.5531 10.0844C22.2563 8.10625 24.4688 8.62812 25.3344 8.30312C26.4656 7.87812 26.7719 7.18437 28.1875 6.89062C29.6844 6.58125 30.725 7.17812 30.725 7.17812C30.725 7.17812 31.0656 6.3875 30.6125 6.01875C30.1594 5.65 29.325 5.3625 27.9312 5.64687C26.4062 5.95625 25.275 6.975 24.9656 7.00312C24.6563 7.03125 21.4906 6.8625 17.7313 9.00937C13.9719 11.1562 13.2688 13.3875 12.4219 13.8688Z" fill="#CB6C22" />
<path d="M16.7438 17.2875L11.6875 18.3906C11.6875 18.3906 11.6094 19.35 11.6594 19.6344C11.8281 20.5938 13.1 22.1219 13.8625 22.375C14.625 22.6281 16.1781 22.6563 16.6875 22.4313C17.1969 22.2063 18.7219 21.1031 18.9188 20.5094C19.1156 19.9156 19.0625 17.4312 18.6688 17.0344C18.275 16.6406 16.7438 17.2875 16.7438 17.2875Z" fill="#DB0D27" />
<path d="M13.1844 15.7063C12.6437 16.125 11.6031 17.5438 11.6875 18.5594C11.7719 19.5781 13.525 21.3563 14.0031 21.525C14.4812 21.6938 16.0375 21.7219 16.4344 21.6094C16.8312 21.4969 18.3562 20.3656 18.5812 19.9719C18.8062 19.575 19.0063 17.3719 18.6375 16.9781C18.2687 16.5844 17.1687 15.425 16.2937 15.1688C15.4156 14.9156 13.6937 15.3094 13.1844 15.7063Z" fill="#ED6D30" />
<path d="M26.125 20.4531C26.125 20.4531 21.65 20.1312 21.5937 20.4125C21.5375 20.6937 21.4344 21.7812 21.7187 22.6563C21.9187 23.2781 22.3969 24.3531 23.8656 24.9719C25.3344 25.5906 26.7469 24.9156 27.1156 24.6313C27.8062 24.1 28.2469 23.4438 28.3594 23.05C28.4719 22.6563 26.125 20.4531 26.125 20.4531Z" fill="#DB0D27" />
<path d="M23.95 18.1062C23.2594 18.3562 21.6063 19.3781 21.575 20.5094C21.5469 21.6406 22.3656 23.025 22.7906 23.3344C23.2156 23.6437 24.6281 24.4656 25.6719 24.4094C26.7188 24.3531 28.1594 23.5062 28.3562 23.0531C28.5531 22.6 28.6375 21.2719 28.5531 20.5937C28.4688 19.9156 27 18.3906 26.2656 18.1625C25.5313 17.9375 24.5719 17.8812 23.95 18.1062Z" fill="#ED6D30" />
<path d="M23.7813 28.675C23.7813 28.675 19.6844 27.5438 19.6281 27.6281C19.5719 27.7125 19.0063 28.4187 19.1469 28.7594C19.2875 29.1 20.7281 30.2562 21.3219 30.7656C21.9156 31.275 23.7094 32.3281 23.9219 32.2906C24.4313 32.2062 24.825 31.3875 24.825 31.3875L23.7813 28.675Z" fill="#DB0D27" />
<path d="M24.1469 26.95C23.1469 26.2156 21.6875 26.2719 20.8969 26.6406C20.1063 27.0094 19.625 27.4875 19.5406 27.8562C19.4562 28.225 20.1094 28.9344 20.3656 29.1312C20.6187 29.3281 21.3875 29.9094 21.3875 29.9094C21.3875 29.9094 22.5281 30.8031 22.95 31.1281C23.5375 31.5812 24.275 31.8375 24.4719 31.8656C24.6688 31.8937 25.5875 30.7062 25.4188 29.1219C25.3313 28.3125 24.9875 27.5687 24.1469 26.95Z" fill="#ED6D30" />
<path d="M31.2687 24.6906L29.7438 24.6344C29.7438 24.6344 29.1219 25.7937 29.5469 27.0937C29.8938 28.1562 30.6219 28.7906 31.8344 29.1281C33.05 29.4688 33.7281 29.3469 33.7281 29.3469L33.7469 28.4938L31.2687 24.6906Z" fill="#DB0D27" />
<path d="M32.7375 22.7406C32.7375 22.7406 30.8562 22.5187 29.8844 24.2656C29.1406 25.6062 29.6594 26.725 30.2531 27.375C30.8469 28.025 31.75 28.45 32.4281 28.5063C33.1063 28.5625 33.7625 28.5094 33.7625 28.5094C33.7625 28.5094 33.5 26.775 33.2438 25.325C33.0875 24.4562 32.7375 22.7406 32.7375 22.7406Z" fill="#ED6D30" />
<path d="M27.2563 10.5062C27.2563 10.5062 23.6125 10.6187 23.3844 10.9875C23.1563 11.3562 23.1594 12.9937 23.2719 13.6437C23.3844 14.2937 24.375 15.875 26.3531 15.9031C28.3313 15.9312 29.0281 15.4375 29.7969 13.9437C30.5656 12.45 29.7656 10.7781 29.7656 10.7781L27.2563 10.5062Z" fill="#DB0D27" />
<path d="M27.2844 8.8375C26.4937 8.68437 25.3906 9.00625 24.8531 9.375C24.3156 9.74375 23.4406 10.5062 23.3844 11.0719C23.3281 11.6375 23.8375 13.275 24.0344 13.5875C24.2313 13.8969 25.05 14.7375 25.3063 14.8594C25.9 15.1406 27.5375 15 28.0188 14.8312C28.5 14.6625 29.8281 13.5875 29.9687 13.0219C30.1094 12.4562 30.2781 11.4969 29.6281 10.3375C28.9781 9.17812 28.0187 8.98125 27.2844 8.8375Z" fill="#ED6D30" />
<path d="M32.4313 32.5531L29.1781 32.4125C29.1781 32.4125 28.7406 33.2906 28.8719 34.0594C28.9781 34.6969 29.5063 35.5656 30.4531 35.9313C30.9906 36.1375 32.3969 36.0031 32.7406 35.7688C33.4344 35.2938 33.6563 34.4313 33.6344 33.9875C33.625 33.7563 32.4313 32.5531 32.4313 32.5531Z" fill="#DB0D27" />
<path d="M31.7219 31.1719C30.8781 31.0438 29.9062 31.5 29.4875 31.9344C29.0688 32.3688 28.9844 32.9125 29.1438 33.5688C29.4344 34.7687 30.2031 35.1094 30.5594 35.2938C31.0875 35.5656 32.5375 35.5125 32.9937 35.1656C33.4469 34.8219 33.7906 34.2344 33.6844 33.3313C33.575 32.425 33.175 31.3906 31.7219 31.1719Z" fill="#ED6D30" />
<path d="M11.25 9.69687C11.2781 10.3719 12.4594 10.2562 12.925 10.2094C13.2969 10.1719 14.2281 10.0937 14.2281 9.4875C14.2281 8.88125 13.4156 8.88437 12.8094 8.90625C12.225 8.92812 11.225 9.1625 11.25 9.69687Z" fill="#FCC12B" />
<path d="M17.5969 5.72187C17.5969 6.16562 18.0844 6.20937 18.3875 6.23437C18.6906 6.25625 19.0844 6.14062 19.1094 5.79375C19.1313 5.44375 18.8313 5.23437 18.3875 5.2125C17.9219 5.18437 17.5969 5.34687 17.5969 5.72187Z" fill="#FCC12B" />
<path d="M20.5031 6.79063C20.95 7.275 21.6187 6.62813 21.8531 6.325C22.0844 6.02188 22.1312 5.55625 21.875 5.325C21.6187 5.09375 21.1312 5.34688 20.8063 5.65C20.4813 5.95313 20.225 6.4875 20.5031 6.79063Z" fill="#FCC12B" />
<path d="M25.55 4.325C26.0938 4.94062 26.9906 3.90625 27.3625 3.55625C27.7344 3.20625 28.0375 2.71875 27.6875 2.325C27.3375 1.93125 26.5469 2.4875 26.2469 2.8375C25.9437 3.18437 25.2 3.93125 25.55 4.325Z" fill="#FCC12B" />
<path d="M8.4125 14.7656C8.94063 14.8906 9.1125 14.2656 9.20313 13.7875C9.29688 13.3 9.29688 12.8344 8.9 12.7656C8.45 12.6875 8.20313 13.1375 8.13125 13.5781C8.07188 13.975 7.925 14.65 8.4125 14.7656Z" fill="#FCC12B" />
<path d="M70.292 11.67L63.974 30H57.448L51.104 11.67H56.564L60.724 24.904L64.858 11.67H70.292ZM86.8038 15.414V30H81.6818V27.92C81.2485 28.5787 80.6505 29.116 79.8878 29.532C79.1252 29.9307 78.2498 30.13 77.2618 30.13C75.5632 30.13 74.2198 29.5753 73.2318 28.466C72.2612 27.3393 71.7758 25.814 71.7758 23.89V15.414H76.8458V23.24C76.8458 24.072 77.0625 24.7307 77.4958 25.216C77.9465 25.684 78.5358 25.918 79.2638 25.918C80.0092 25.918 80.5985 25.684 81.0318 25.216C81.4652 24.7307 81.6818 24.072 81.6818 23.24V15.414H86.8038ZM92.278 14.062C91.3767 14.062 90.6487 13.8193 90.094 13.334C89.5567 12.8313 89.288 12.2073 89.288 11.462C89.288 10.6993 89.5567 10.0667 90.094 9.564C90.6487 9.06133 91.3767 8.81 92.278 8.81C93.162 8.81 93.8727 9.06133 94.41 9.564C94.9647 10.0667 95.242 10.6993 95.242 11.462C95.242 12.2073 94.9647 12.8313 94.41 13.334C93.8727 13.8193 93.162 14.062 92.278 14.062ZM94.8 15.414V30H89.704V15.414H94.8ZM106.308 25.658V30H104.098C100.371 30 98.5081 28.154 98.5081 24.462V19.652H96.7141V15.414H98.5081V11.878H103.63V15.414H106.282V19.652H103.63V24.54C103.63 24.9387 103.717 25.2247 103.89 25.398C104.081 25.5713 104.393 25.658 104.826 25.658H106.308ZM115.431 30.182C113.975 30.182 112.667 29.8787 111.505 29.272C110.361 28.6653 109.46 27.7987 108.801 26.672C108.143 25.5453 107.813 24.2193 107.813 22.694C107.813 21.186 108.143 19.8687 108.801 18.742C109.477 17.6153 110.387 16.7487 111.531 16.142C112.693 15.5353 114.001 15.232 115.457 15.232C116.913 15.232 118.213 15.5353 119.357 16.142C120.519 16.7487 121.429 17.6153 122.087 18.742C122.763 19.8687 123.101 21.186 123.101 22.694C123.101 24.202 122.763 25.528 122.087 26.672C121.429 27.7987 120.519 28.6653 119.357 29.272C118.196 29.8787 116.887 30.182 115.431 30.182ZM115.431 25.762C116.142 25.762 116.731 25.502 117.199 24.982C117.685 24.4447 117.927 23.682 117.927 22.694C117.927 21.706 117.685 20.952 117.199 20.432C116.731 19.912 116.151 19.652 115.457 19.652C114.764 19.652 114.183 19.912 113.715 20.432C113.247 20.952 113.013 21.706 113.013 22.694C113.013 23.6993 113.239 24.462 113.689 24.982C114.14 25.502 114.721 25.762 115.431 25.762Z" fill="currentColor" />
</svg>
</template>
107 changes: 107 additions & 0 deletions docs/content/0.index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
title: Home
navigation: false
layout: page
main:
fluid: false
---

:ellipsis{right=0px width=75% blur=150px :colors='["rgba(250, 120, 0, 0.22)", "rgba(243, 191, 57, 0.22)", "rgba(243, 79, 57, 0.22)"]'}

::block-hero
---
cta:
- Get started
- /introduction/getting-started
secondary:
- Open on GitHub →
- https://github.com/mathix420/vuito
---

#title
Full-stack validations made easy.

#description
Simple, lightweight, isomorphic, template-based validation library.

#extra
::list
- Only **778 Bytes** gz for all modules
- **Tree-Shakeable** use only what you need
- **Template based**, share validations across projects with ease
- **Isomorphic**; Server or Client-Side, it doesn't matter
- No dependencies!
- Easy to [Extend and Configure](/api)
- Plug and play [Vue.js Mixin](/introduction/vue-mixin)
::

#support
::code-group
```bash [NPM]
npm i vuito
```
```bash [Bun]
bun i vuito
```
```bash [Yarn]
yarn add vuito
```
```bash [PNPM]
pnpm i vuito
```
```bash [NI]
ni vuito # github.com/antfu/ni
```
::
::

::card-grid
#title
What's included

#root
:ellipsis{left=0px width=40rem top=10rem blur=140px :colors='["rgba(250, 120, 0, 0.15)", "rgba(243, 191, 57, 0.15)", "rgba(243, 79, 57, 0.15)"]'}

#default
::card{icon=simple-icons:github}
#title
Shareable templates
#description
Share your validations template accross multiple projects.
::

::card{icon=noto:rocket}
#title
Use anywhere
#description
Vuito is isomorphic by design, you can use wherever you want.
::

::card{icon=logos:vue}
#title
Vue Mixin
#description
Install the vue mixin and you're good to go!
::

::card{icon=noto:puzzle-piece}
#title
Easily extensible
#description
Add validators helpers with ease.
::

::card{icon=noto:evergreen-tree}
#title
Tree-Shakeable
#description
Do not ship unecessary code.
::

::card{icon=fxemoji:babybottle}
#title
Simple API
#description
No learning curve, intuitive API design.
::
::
Loading

0 comments on commit b732e92

Please sign in to comment.