Skip to content

Commit

Permalink
improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
infinite-system committed Aug 18, 2024
1 parent 83d4d78 commit 369e962
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 9 deletions.
2 changes: 2 additions & 0 deletions docs/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ export default defineConfig({
text: 'Core Functions',
items: [
{ text: 'ivue()', link: '/pages/api#ivue' },
{ text: 'iref()', link: '/pages/api#iref' },
{ text: 'iuse()', link: '/pages/api#iuse' },
{ text: '.init()', link: '/pages/api#init' },
{ text: '.toRefs()', link: '/pages/api#torefs' },
],
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/Component.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup lang="ts">
import { ivue } from "../../../src/index";
import { ivue } from "../../../src/ivue";
import { VueDd } from "vue-dd";
import { ref } from 'vue';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/components/usage/CounterComposables.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<script setup lang="ts">
import { useMouse } from '@vueuse/core';
import { ivue, iref, iuse } from '../../../../src/index';
import { ivue, iref, iuse } from '../../../../src/ivue';
class Counter {
count = iref(0);
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/pages/browse-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
aside: false
---
# Source code
Or [Browse the source code on GitHub](https://github.com/infinite-system/ivue/blob/main/src/index.ts)
Or [Browse the source code on GitHub](https://github.com/infinite-system/ivue/blob/main/src/ivue.ts)

## Install by Copying

Expand All @@ -14,5 +14,5 @@ This installation path is recommended only if you quickly want to tinker with th
:::

:::code-group
<<< ../../../src/index.ts{ts:line-numbers} [ivue.ts]
<<< ../../../src/ivue.ts{ts:line-numbers} [ivue.ts]
:::
4 changes: 2 additions & 2 deletions docs/docs/pages/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ pnpm i ivue
:::details Click to expand the latest `ivue` source code to copy

:::code-group
<<< ../../../src/index.ts{ts:line-numbers} [ivue.ts]
<<< ../../../src/ivue.ts{ts:line-numbers} [ivue.ts]
:::
Or [Copy from GitHub](https://github.com/infinite-system/ivue/blob/main/src/index.ts)
Or [Copy from GitHub](https://github.com/infinite-system/ivue/blob/main/src/ivue.ts)

::: tip NOTE
This installation path is recommended only if you quickly want to tinker with the internals of ivue, as you won't be getting the latest updates. Also note that this code comes from github `main` branch latest which might also be in beta and not fully published to `npm`.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/pages/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ Utility Types help to achieve the rest of `ivue` capabilities

:::details Click to see the whole latest `ivue` source code from github main branch below:
:::code-group
<<< ../../../src/index.ts{ts:line-numbers} [ivue.ts]
<<< ../../../src/ivue.ts{ts:line-numbers} [ivue.ts]
:::
Or [See on GitHub](https://github.com/infinite-system/ivue/blob/main/src/index.ts)
Or [See on GitHub](https://github.com/infinite-system/ivue/blob/main/src/ivue.ts)

## 100% Vue 3 Compatible
`.toRefs()` allows the object to be converted to Vue 3 native composable structure with full `.value`s, so it can interoperate with native composables if needed. `.toRefs()` is also often used to get refs for `v-bind()` in css styles.
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"build": "vitepress build docs",
"serve": "vitepress serve docs",
"preview": "vitepress build docs && vitepress serve docs",
"deploy": "node scripts/gh-pages-deploy.js",
"deploy": "node scripts/gh-pages-deploy.js"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^5.10.0",
Expand Down

0 comments on commit 369e962

Please sign in to comment.