Skip to content

Commit 7998806

Browse files
committed
chore(docs): cleanup docs from my old childish bold bad habit
1 parent 6c81980 commit 7998806

23 files changed

+79
-79
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
Vue Composables putting your components in motion
88

9-
- 🏎 **Smooth animations** based on [**Popmotion**](https://popmotion.io/)
10-
- 🎮 **Declarative** API inspired by [**Framer Motion**](https://www.framer.com/motion/)
9+
- 🏎 **Smooth animations** based on [Popmotion](https://popmotion.io/)
10+
- 🎮 **Declarative** API inspired by [Framer Motion](https://www.framer.com/motion/)
1111
- 🚀 **Plug** & **play** with **20+ presets**
1212
- 🌐 **SSR Ready**
1313
- 🚚 First-class support for **Nuxt 3**

docs/content/1.getting-started/1.introduction.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ description: "Let's get started with `@vueuse/motion`."
66
::person
77
::
88

9-
[**CodeSandbox**](https://codesandbox.io/s/vueusemotion-me1jn?file=/src/components/Person.vue) for this example.
9+
[CodeSandbox](https://codesandbox.io/s/vueusemotion-me1jn?file=/src/components/Person.vue) for this example.
1010

11-
Illustration from [**Pebble People**](https://blush.design/fr/collections/pebble-people) by [**Deivid Saenz**](https://blush.design/fr/artists/deivid-saenz).
11+
Illustration from [Pebble People](https://blush.design/fr/collections/pebble-people) by [Deivid Saenz](https://blush.design/fr/artists/deivid-saenz).
1212

1313
```bash
1414
yarn add @vueuse/motion
@@ -48,12 +48,12 @@ export default {
4848

4949
## Usage
5050

51-
- How to use **directives**? Check out [**Directive Usage**](/features/directive-usage).
51+
- How to use directives? Check out [Directive Usage](/features/directive-usage).
5252

53-
- What **properties** you can **animate**? Check out [**Motion Properties**](/features/motion-properties).
53+
- What properties you can animate? Check out [Motion Properties](/features/motion-properties).
5454

55-
- How to **create** your own **animations** styles? Check out [**Transition Properties**](/features/transition-properties).
55+
- How to create your own animations styles? Check out [Transition Properties](/features/transition-properties).
5656

57-
- What are **variants** and how you can **use** them? Check out [**Variants**](/features/variants).
57+
- What are variants and how you can use them? Check out [Variants](/features/variants).
5858

59-
- How to **control** your declared **variants**? Check out [**Motion Instance**](/features/motion-instance).
59+
- How to control your declared variants? Check out [Motion Instance](/features/motion-instance).

docs/content/1.getting-started/2.nuxt.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Nuxt Usage
22

3-
If you are using [**Nuxt**](https://nuxtjs.org/), this package has a specific implementation that makes the declaration of custom directives even easier.
3+
If you are using [Nuxt](https://nuxtjs.org/), this package has a specific implementation that makes the declaration of custom directives even easier.
44

55
It is shipped with `@vueuse/motion` and is importable via `@vueuse/motion/nuxt`.
66

docs/content/2.features/0.presets.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ toc: false
66

77
It allows you to start implementing animations straight after installing the plugin in your Vue app.
88

9-
You can add your own presets to your app using [**Custom Directives**](/features/directive-usage#custom-directives).
9+
You can add your own presets to your app using [Custom Directives](/features/directive-usage#custom-directives).
1010

11-
If you have any ideas for new presets add an issue on [**GitHub**](https://github.com/vueuse/motion#issues), or reach me on [**Twitter**](https://twitter.com/yaeeelglx).
11+
If you have any ideas for new presets add an issue on [GitHub](https://github.com/vueuse/motion#issues), or reach me on [Twitter](https://twitter.com/yaeeelglx).
1212

1313
<PresetsViewer />

docs/content/2.features/1.directive-usage.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ You can also pass your variants as an object using the `:variants` prop.
2828

2929
The `:variants` prop will be combined with all the other native variants properties, allowing you to define only your custom variants from this object.
3030

31-
The rest of the variants properties can be found on the [**Variants**](/features/variants) page.
31+
The rest of the variants properties can be found on the [Variants](/features/variants) page.
3232

3333
As a shorthand, you can use the `:delay` prop, that allows you to edit the delay from the element props.
3434

3535
If you specified `visible`, `visible-once` or `enter` variant, the delay will be applied to each of them.
3636

37-
Otherwise, the delay will be applied on the `initial` [**variant**](/features/variants).
37+
Otherwise, the delay will be applied on the `initial` [variant](/features/variants).
3838

3939
```vue
4040
<template>
@@ -55,7 +55,7 @@ Otherwise, the delay will be applied on the `initial` [**variant**](/features/va
5555

5656
When defined from template, the target element might not be assigned to a ref.
5757

58-
You can access motions controls using [**useMotions**](/api/use-motions).
58+
You can access motions controls using [useMotions](/api/use-motions).
5959

6060
If you want to access a v-motion, you will have to give the element a name as v-motion value.
6161

@@ -84,7 +84,7 @@ const customEvent = () => {
8484
</script>
8585
```
8686

87-
In the above example, the custom object will be an instance of [**Motion Instance**](/features/motion-instance).
87+
In the above example, the custom object will be an instance of [Motion Instance](/features/motion-instance).
8888

8989
### Custom Directives
9090

docs/content/2.features/2.composable-usage.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The target can be HTML or SVG elements, or references to these types.
1616

1717
The second parameter are the `variants`.
1818

19-
The [**Variants Definitions**](/features/variants) are described in a specific page.
19+
The [Variants Definitions](/features/variants) are described in a specific page.
2020

2121
```vue
2222
<script setup>
@@ -37,6 +37,6 @@ const motionInstance = useMotion(target, {
3737
</script>
3838
```
3939

40-
Once called, the useMotion composable will return an instance of [**Motion Instance**](/features/motion-instance).
40+
Once called, the useMotion composable will return an instance of [Motion Instance](/features/motion-instance).
4141

4242
By using this motion instance members, you will be able to animate the element with ease.

docs/content/2.features/3.motion-properties.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Motion properties are represented by an object containing all the animatable properties of an element.
44

5-
They are one of the two parts that compose a [**Variant**](/features/variants), with [**Transitions Declaration**](/features/transition-properties).
5+
They are one of the two parts that compose a [Variant](/features/variants), with [Transitions Declaration](/features/transition-properties).
66

7-
This object contains both **style** and **transform** properties.
7+
This object contains both style and transform properties.
88

99
Note that when interacting with both style and transform properties, you are not forced to specify units and can instead just use numbers.
1010

@@ -26,9 +26,9 @@ Style properties are used to decompose a regular `style` CSS string into individ
2626

2727
The typings are the same as the regular `style` property from Vue templates.
2828

29-
All the regular [**CSS Style**](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference) properties are supported.
29+
All the regular [CSS Style](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference) properties are supported.
3030

31-
Some keys are **forbidden** (`transition`, `rotate`, `scale`...) as they are now reserved for [**Transform Properties**](#transform-properties).
31+
Some keys are **forbidden** (`transition`, `rotate`, `scale`...) as they are now reserved for [Transform Properties](#transform-properties).
3232

3333
```javascript
3434
{
@@ -43,7 +43,7 @@ Some keys are **forbidden** (`transition`, `rotate`, `scale`...) as they are now
4343

4444
Transform properties are used to decompose a regular `transform` CSS string into individual object keys.
4545

46-
All the regular [**CSS Transform**](https://developer.mozilla.org/en-US/docs/Web/CSS/transform#syntax) syntax arguments are supported.
46+
All the regular [CSS Transform](https://developer.mozilla.org/en-US/docs/Web/CSS/transform#syntax) syntax arguments are supported.
4747

4848
As an addition, you can use `x`, `y`, `z` properties, that will be converted into `translateX`, `translateY` and `translateZ`.
4949

docs/content/2.features/4.transition-properties.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Transition properties are represented by an object containing all transition parameters of a variant.
44

5-
They are one of the two parts that compose a [**Variant**](/features/variants), with [**Motion Properties**](/features/motion-properties).
5+
They are one of the two parts that compose a [Variant](/features/variants), with [Motion Properties](/features/motion-properties).
66

77
## Orchestration
88

@@ -29,7 +29,7 @@ You can specify a delay which will be added every time the transition is pushed.
2929

3030
### Repeat
3131

32-
The native [**Popmotion Repeat**](https://popmotion.io/#quick-start-animation-animate-options-repeat) feature is supported.
32+
The native [Popmotion Repeat](https://popmotion.io/#quick-start-animation-animate-options-repeat) feature is supported.
3333

3434
Three parameters are available:
3535

@@ -61,7 +61,7 @@ Three parameters are available:
6161

6262
Two types of animations are supported.
6363

64-
For the most [**Common Animatable Properties**](https://github.com/vueuse/motion/blob/main/src/utils/defaults.ts#L43), it will uses generated spring transitions.
64+
For the most [Common Animatable Properties](https://github.com/vueuse/motion/blob/main/src/utils/defaults.ts#L43), it will uses generated spring transitions.
6565

6666
The rest of the properties might be using keyframes.
6767

docs/content/2.features/5.variants.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Variants represent an animatable state for your element.
44

5-
They are composed of any [**Motion Properties**](/features/motion-properties) and an optional [**Transition Properties**](/features/transition-properties).
5+
They are composed of any [Motion Properties](/features/motion-properties) and an optional [Transition Properties](/features/transition-properties).
66

77
```vue
88
<div
@@ -51,7 +51,7 @@ It is recommended to include a base state for each parameter that you are willin
5151

5252
The enter variant will be applied on the second tick of the element, right after its creation.
5353

54-
You can use it to trigger an animation when the element appears, transitioning from [**Initial**](#initial-variant) variant.
54+
You can use it to trigger an animation when the element appears, transitioning from [Initial](#initial-variant) variant.
5555

5656
```vue
5757
<div
@@ -91,19 +91,19 @@ The leave variant helps to define the state of an element when it is supposed to
9191
/>
9292
```
9393

94-
In order to achieve a leave transition, you will have to access the [**Motion Instance**](/features/motion-instance).
94+
In order to achieve a leave transition, you will have to access the [Motion Instance](/features/motion-instance).
9595

9696
This instance exposes an helper called `leave` than can easily be mapped with the Vue transition element @leave event.
9797

98-
You can take a look at an example of implementation on the [**Demo**](https://vueuse-motion-demo.netlify.app) page, at the "**Transitions**" section.
98+
You can take a look at an example of implementation on the [Demo](https://vueuse-motion-demo.netlify.app) page, at the "**Transitions**" section.
9999

100100
## Visibility Variants
101101

102102
### Visible
103103

104104
The visible variant will be applied when the element enters the viewport.
105105

106-
When the element leaves, the [**Initial**](#initial-variant) variant will be applied again.
106+
When the element leaves, the [Initial](#initial-variant) variant will be applied again.
107107

108108
```vue
109109
<div

docs/content/2.features/6.motion-instance.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Motion Instance
22

3-
Motion instance is the object exposed when binding to a target element using [**v-motion**](/features/directive-usage) or [**useMotion**](/features/composable-usage).
3+
Motion instance is the object exposed when binding to a target element using [v-motion](/features/directive-usage) or [useMotion](/features/composable-usage).
44

55
It is composed of three properties, allowing you to interact with the element.
66

@@ -51,7 +51,7 @@ This is useful when used with event listeners, or any temporary modification to
5151

5252
This is also useful for orchestration, as apply returns a promise, you can await it and chain variant applying.
5353

54-
Apply accepts both a [**Variant Declaration**](/features/variants) or a key from the motion instance variants.
54+
Apply accepts both a [Variant Declaration](/features/variants) or a key from the motion instance variants.
5555

5656
```vue
5757
<script setup lang="ts">
@@ -94,7 +94,7 @@ Stop is a function that lets you stop ongoing animations for a specific element.
9494

9595
Calling it without argument will be stopping all the animations.
9696

97-
Calling it with an array of [**Motion Properties**](/features/motion-properties) keys will stop every specified key.
97+
Calling it with an array of [Motion Properties](/features/motion-properties) keys will stop every specified key.
9898

9999
Calling it with a single motion property key will stop the specified key.
100100

docs/content/3.api/1.use-motion.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# useMotion
22

3-
useMotion is the **core** composable of this **package**.
3+
useMotion is the core composable of this package.
44

5-
This composable **imports** every other **composable** and **expose** a **motion instance**.
5+
This composable imports every other composable and expose a motion instance.
66

7-
[**useMotionProperties**](/api/use-motion-properties) is used to make the **element** styling properties **reactive**.
7+
[useMotionProperties](/api/use-motion-properties) is used to make the element styling properties reactive.
88

9-
[**useMotionTransitions**](/api/use-motion-transitions) is used to manage **transitions** scheduling and **execution**.
9+
[useMotionTransitions](/api/use-motion-transitions) is used to manage transitions scheduling and execution.
1010

11-
[**useMotionVariants**](/api/use-motion-variants) is used to handle **variants** and variant **selection**.
11+
[useMotionVariants](/api/use-motion-variants) is used to handle variants and variant selection.
1212

13-
[**useMotionControls**](/api/use-motion-controls) is used to create motion **controls** from variants, properties and transitions.
13+
[useMotionControls](/api/use-motion-controls) is used to create motion controls from variants, properties and transitions.
1414

15-
[**useMotionFeatures**](/api/use-motion-features) is used to register **lifecycle** hooks bindings, **visibility** and **events** listeners.
15+
[useMotionFeatures](/api/use-motion-features) is used to register lifecycle hooks bindings, visibility and events listeners.
1616

1717
## Parameters
1818

@@ -26,7 +26,7 @@ If the target reference is updated, the current variant will be applied to the n
2626

2727
**Variants** must be an object or an object reference.
2828

29-
Keys are variants names, values are [**Variants Declarations**](/features/variants).
29+
Keys are variants names, values are [Variants Declarations](/features/variants).
3030

3131
### `options`
3232

@@ -47,7 +47,7 @@ Target is a reference to the element you passed as a parameter.
4747

4848
### `variant`
4949

50-
Variant is a string reference, from [**useMotionVariants**](/api/use-motion-variants).
50+
Variant is a string reference, from [useMotionVariants](/api/use-motion-variants).
5151

5252
### `variants`
5353

@@ -59,7 +59,7 @@ State is a computed reference to the current variant applied to your element.
5959

6060
### `...controls`
6161

62-
Spread object from [**Motion Controls**](/api/use-motion-controls) exposed functions.
62+
Spread object from [Motion Controls](/api/use-motion-controls) exposed functions.
6363

6464
## Example
6565

docs/content/3.api/10.use-element-transform.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
useElementTransform is used to sync a reactive object to a target element CSS transform.
44

5-
It uses [**reactiveTransform**](https://github.com/vueuse/motion/blob/main/src/reactiveTransform.ts) and binds it to a target.
5+
It uses [reactiveTransform](https://github.com/vueuse/motion/blob/main/src/reactiveTransform.ts) and binds it to a target.
66

77
## Parameters
88

@@ -16,7 +16,7 @@ If the target reference is updated, the current transform will be updated from t
1616

1717
### `transform`
1818

19-
Transform is the current `target` [**Transform Properties**](/features/motion-properties#transform-properties) as a reactive object.
19+
Transform is the current `target` [Transform Properties](/features/motion-properties#transform-properties) as a reactive object.
2020

2121
When you change a value, it will update the element transform property accordingly.
2222

docs/content/3.api/11.reactive-style.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ reactiveStyle is an helper function creating a reactive object compatible with a
66

77
### `props`
88

9-
Default [**StyleProperties**](https://github.com/Tahul/vueuse/motion/tree/main/src/types/variants.ts#L49-L50) object to create the reactive one from.
9+
Default [StyleProperties](https://github.com/Tahul/vueuse/motion/tree/main/src/types/variants.ts#L49-L50) object to create the reactive one from.
1010

1111
## Exposed
1212

1313
### `state`
1414

15-
The reactive [**StyleProperties**](https://github.com/Tahul/vueuse/motion/tree/main/src/types/variants.ts#L49-L50) object to manipulate.
15+
The reactive [StyleProperties](https://github.com/Tahul/vueuse/motion/tree/main/src/types/variants.ts#L49-L50) object to manipulate.
1616

1717
### `style`
1818

19-
A reactive [**style attribute**](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/style) compatible string.
19+
A reactive [style attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/style) compatible string.
2020

2121
#### Example
2222

docs/content/3.api/12.reactive-transform.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ reactiveTransform is an helper function creating a reactive object compatible wi
66

77
### `props`
88

9-
Default [**TransformProperties**](https://github.com/vueuse/motion/tree/main/src/types/variants.ts#L21) object to create the reactive one from.
9+
Default [TransformProperties](https://github.com/vueuse/motion/tree/main/src/types/variants.ts#L21) object to create the reactive one from.
1010

1111
## Exposed
1212

1313
### `state`
1414

15-
The reactive [**TransformProperties**](https://github.com/vueuse/motion/tree/main/src/types/variants.ts#L21) object to manipulate.
15+
The reactive [TransformProperties](https://github.com/vueuse/motion/tree/main/src/types/variants.ts#L21) object to manipulate.
1616

1717
### `style`
1818

19-
A reactive [**transform attribute**](https://developer.mozilla.org/en-US/docs/Web/CSS/transform) compatible string.
19+
A reactive [transform attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/transform) compatible string.
2020

2121
#### Example
2222

docs/content/3.api/2.use-spring.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# useSpring
22

3-
useSpring is a simpler hook than [**useMotion**](/api/use-motion).
3+
useSpring is a simpler hook than [useMotion](/api/use-motion).
44

55
It has been implemented in order for you to implement Spring animations in your apps, without the pain.
66

77
useSpring can be bound to a HTML or SVG element, or to a simple object.
88

9-
It skips the [**Variants**](/features/variants) system, allowing it to be as performant as using Popmotion natively, but with a nicer **API** to play with Vue refs.
9+
It skips the [Variants](/features/variants) system, allowing it to be as performant as using Popmotion natively, but with a nicer **API** to play with Vue refs.
1010

1111
## Parameters
1212

@@ -16,7 +16,7 @@ Target can be an element (**SVG** / **HTML**), or an object.
1616

1717
### `spring`
1818

19-
The spring argument takes a [**Spring definition**](https://popmotion.io/#quick-start-animation-animate-spring-options) from **Popmotion**.
19+
The spring argument takes a [Spring definition](https://popmotion.io/#quick-start-animation-animate-spring-options) from **Popmotion**.
2020

2121
It is optional as a default Spring will be applied if you do not specify it.
2222

docs/content/3.api/3.use-motions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Be careful about duplicating the same name, note that the name can be including
1212

1313
useMotions exposes an object in which keys are defined from all the **v-motion** for which you defined a name value.
1414

15-
Each values are [**Motion Instances**](/features/motion-instance) for the named elements.
15+
Each values are [Motion Instances](/features/motion-instance) for the named elements.
1616

1717
## Example
1818

0 commit comments

Comments
 (0)