Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
antfu committed Feb 22, 2021
1 parent 2b2a79d commit 4125d43
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 16 deletions.
8 changes: 2 additions & 6 deletions packages/.vitepress/theme/components/NavBar.vue
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<template>
<header class="nav-bar" :class="{ root: isRoot }">
<header class="nav-bar">
<ToggleSideBarButton @toggle="$emit('toggle')" />

<NavBarTitle v-if="!isRoot" />
<NavBarTitle />

<div class="flex-grow" />

Expand All @@ -28,17 +28,13 @@

<script setup lang="ts">
import { defineEmit, toRef } from 'vue'
import { useRoute } from 'vitepress'
import { useRepo } from '../composables/repo'
import NavBarTitle from './NavBarTitle.vue'
import NavLinks from './NavLinks.vue'
import ToggleSideBarButton from './ToggleSideBarButton.vue'
import DarkModeSwitch from './DarkModeSwitch.vue'
import { is } from 'vue-chemistry/boolean'
const repo = useRepo()
const route = useRoute()
const isRoot = is(toRef(route, 'path'), '/')
defineEmit(['toggle'])
</script>
Expand Down
37 changes: 28 additions & 9 deletions packages/add-ons.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,45 @@
The core package aims to be lightweight and dependence free. While the add-ons are wrapping popular packages into the consistent API style.


### Head - [`@vueuse/head`](https://github.com/vueuse/head) <carbon-link class="external-link"/>
## Head - [`@vueuse/head`](https://github.com/vueuse/head) <carbon-link class="external-link"/>
Document head manager for Vue 3. SSR ready. Created and maintained by [@egoist](https://github.com/egoist)

## Motion - [`@vueuse/motion`](https://github.com/vueuse/motion) <carbon-link class="external-link"/>

### Motion - [`@vueuse/motion`](https://github.com/vueuse/motion) <carbon-link class="external-link"/>
Vue composables putting your components in motion. Created and maintained by [@Tahul](https://github.com/Tahul)
**Vue Composables** putting your **components** in **motion**.

### Sound - [`@vueuse/sound`](https://github.com/vueuse/sound) <carbon-link class="external-link"/>
Vue composables for playing sound effects. Created and maintained by [@Tahul](https://github.com/Tahul)
- 🏎 **Smooth animations** based on [**Popmotion**](https://popmotion.io/)
- 🎮 **Declarative** API
- 🚀 **Plug** & **play** with **10+ presets**
- ✅ Supports **Vue 2 & 3** using [**vue-demi**](https://github.com/antfu/vue-demi)
- 🚚 Supports **Nuxt** using [**nuxt-use-motion**](https://github.com/Tahul/nuxt-use-motion)
- ✨ Written in **TypeScript**
- 🏋️‍♀️ Lightweight with **<20kb** bundle size

> Created and maintained by [@Tahul](https://github.com/Tahul)
## Sound - [`@vueuse/sound`](https://github.com/vueuse/sound) <carbon-link class="external-link"/>
Vue composables for playing sound effects.

- 👂 Lets your website **communicate** using 2 **human senses** instead of 1
- 🔥 Built with **Vue** Composition API
- ✅ Supports **Vue 2 & 3** using [**vue-demi**](https://github.com/antfu/vue-demi)
- 🚚 Supports **Nuxt** using [**nuxt-use-sound**](https://github.com/Tahul/nuxt-use-sound)
- ⚡️ **<1kb** bytes (gzip) in your **bundle**! **~10kb** loaded **async**.
- ✨ Built with **TypeScript**
- 🗣 Uses a powerful, battle-tested audio utility: [**Howler.js**](https://howlerjs.com/)

> Created and maintained by [@Tahul](https://github.com/Tahul)
<!--GENERATED LIST, DO NOT MODIFY MANUALLY-->
<!--ADDONS_LIST_STARTS-->
### Router - [`@vueuse/router`](https://vueuse.org/router/README.html)
## Router - [`@vueuse/router`](https://vueuse.org/router/README.html)
Utilities for vue-router
- [`useRouteHash`](https://vueuse.org/router/useRouteHash/) — shorthand for reactive route.hash
- [`useRouteQuery`](https://vueuse.org/router/useRouteQuery/) — shorthand for reactive route.query


### Integrations - [`@vueuse/integrations`](https://vueuse.org/integrations/README.html)
## Integrations - [`@vueuse/integrations`](https://vueuse.org/integrations/README.html)
Integration wrappers for utility libraries
- [`useAxios`](https://vueuse.org/integrations/useAxios/) — wrapper for [`axios`](https://github.com/axios/axios)
- [`useCookies`](https://vueuse.org/integrations/useCookies/) — wrapper for [`universal-cookie`](https://www.npmjs.com/package/universal-cookie)
Expand All @@ -32,15 +51,15 @@ Integration wrappers for utility libraries
- [`useQRCode`](https://vueuse.org/integrations/useQRCode/) — wrapper for [`qrcode`](https://github.com/soldair/node-qrcode)


### RxJS - [`@vueuse/rxjs`](https://vueuse.org/rxjs/README.html)
## RxJS - [`@vueuse/rxjs`](https://vueuse.org/rxjs/README.html)
Enables RxJS reactive functions in Vue
- [`from`](https://vueuse.org/rxjs/from/) — / fromEvent
- [`toObserver`](https://vueuse.org/rxjs/toObserver/) — sugar function to convert a ref in an observer
- [`useObservable`](https://vueuse.org/rxjs/useObservable/) — use an Observable
- [`useSubscription`](https://vueuse.org/rxjs/useSubscription/) — uses subscriptions without worry about unsubscribing to it or memory leaks


### Firebase - [`@vueuse/firebase`](https://vueuse.org/firebase/README.html)
## Firebase - [`@vueuse/firebase`](https://vueuse.org/firebase/README.html)
Enables realtime bindings for Firebase
- [`useAuth`](https://vueuse.org/firebase/useAuth/) — reactive [Firebase Auth](https://firebase.google.com/docs/auth) binding
- [`useFirestore`](https://vueuse.org/firebase/useFirestore/) — reactive [Firestore](https://firebase.google.com/docs/firestore) binding
Expand Down
2 changes: 1 addition & 1 deletion scripts/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ export async function updateFunctionsMD({ packages, functions }: PackageIndexes)
const addons = Object.values(packages)
.filter(i => i.addon && !i.deprecated)
.map(({ docs, name, display, description }) => {
return `### ${display} - [\`@vueuse/${name}\`](${docs})\n${description}\n${
return `## ${display} - [\`@vueuse/${name}\`](${docs})\n${description}\n${
stringifyFunctions(functions.filter(i => i.package === name), false)}`
})
.join('\n')
Expand Down

0 comments on commit 4125d43

Please sign in to comment.