Skip to content

Commit f949279

Browse files
committed
docs: fix formatting
1 parent 9e93886 commit f949279

File tree

10 files changed

+16
-16
lines changed

10 files changed

+16
-16
lines changed

docs/cookbook/migration-v2-v3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ app.use(VueFire, {
117117

118118
## Vuexfire
119119

120-
:::tip
120+
::: tip
121121
If you are using [Pinia](https://pinia.vuejs.org/), make sure to check the [Pinia guide](./subscriptions-external.md#pinia) instead.
122122
:::
123123

docs/guide/auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ router.beforeEach(async () => {
4343
})
4444
```
4545

46-
:::tip
46+
::: tip
4747
If you are using `getCurrentUser()` in a navigation guard, make sure to add it before calling `app.use(router)` as that will trigger the initial navigation.
4848
:::
4949

docs/guide/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ yarn add vuefire firebase
1212
npm install vuefire firebase
1313
```
1414

15-
:::warning
15+
::: warning
1616

1717
VueFire requires Firebase JS SDK >= 9 but **is compatible with Vue 2 and Vue 3**. It's currently in alpha, make sure to check [the Roadmap](https://github.com/vuejs/vuefire/issues/1241) and report any issue you find.
1818

@@ -38,7 +38,7 @@ export const firestore = getFirestore(firebase)
3838
// ... other firebase exports
3939
```
4040

41-
:::tip
41+
::: tip
4242
Note that we will refer to `database` and `firestore` as `db` in examples where only one of them is used.
4343
:::
4444

docs/guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ createApp({
129129

130130
</FirebaseExample>
131131

132-
:::warning
132+
::: warning
133133

134134
- In the [**RTDB** example](#original_rtdb), we are omitting the unsubscribe part because it requires to save the return of every listener created to later on call `this.todosRef.off` with _every single_ one of them.
135135
- In the [**Firestore** example](#original_firestore), the code above is not taking into account [Firestore references](https://firebase.google.com/docs/firestore/data-model#references) which **considerably** increases the complexity of binding and [is handled transparently](./realtime-data.md#references-firestore-only) by Vuefire

docs/guide/nuxt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Nuxt.js
22

3-
:::warning
3+
::: warning
44
The Nuxt module and this docs are a WIP. Things might not work yet.
55
:::
66

docs/guide/old_writing-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ As said in the introduction, Vuefire **does not** handle writing data back to Fi
66

77
There are two ways to update a document `set` and `update`. The first will replace the whole document (as a PUT in HTTP) while the later will keep the original document and overwrite values (as a PATCH in HTTP).
88

9-
:::tip
9+
::: tip
1010
In the following examples, `this.user` is a user bound to a Firebase document using Vuefire while `this.conferences` is a list of conferences bound to a Firebase collection using Vuefire.
1111
:::
1212

docs/guide/options-api-realtime-data.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Options API Realtime Data
22

3-
:::tip
3+
::: tip
44
This pages assumes you have read the [Realtime Data](./realtime-data.md) page and will only cover the syntax differences between the Options API and the Composition API.
55
:::
66

@@ -89,7 +89,7 @@ export default {
8989

9090
</FirebaseExample>
9191

92-
:::warning
92+
::: warning
9393
You must declare properties with their initial values in `data`. **For the RTDB, using an _Array_ as the initial value will bind the Reference as an array, otherwise it is bound as an object**. For Firestore, collections and queries are bound as arrays while documents are bound as objects.
9494
:::
9595

@@ -151,7 +151,7 @@ export default {
151151

152152
With the approach above, `user` will always be bound to the user defined by the prop `id`
153153

154-
:::tip
154+
::: tip
155155
No need to call `$databaseUnbind`/`$firestoreUnbind` as `$databaseBind`/`$firestoreBind` will automatically unbind any existing binding on the provided key. Upon component removal, all bindings are removed as well, so no need to use `$databaseUnbind`/`$firestoreUnbind` in `unmounted` hooks.
156156
:::
157157

docs/guide/realtime-data.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Realtime Data
22

3-
:::info
3+
::: info
44
If you are looking for the VueFire Options API guide, make sure to **also check** the [dedicated page](./options-api-realtime-data.md). This page still includes a more information than the Options API page, which focuses more on its syntax.
55
:::
66

@@ -67,7 +67,7 @@ const contact = useDocument(contactSource)
6767

6868
This way, if the route changes, the document will be updated to the new one, automatically unsubscribing from the previous one and subscribing to the new one.
6969

70-
:::tip
70+
::: tip
7171
If you can't use a `computed()`, use `shallowRef()`s instead of `ref()`s to store the data sources. This is because `shallowRef()` doesn't try to recursively observe the object it's given, which in the case of a Firebase data source, would be wasteful.
7272
:::
7373

@@ -93,7 +93,7 @@ const {
9393

9494
Notice how we rename `data` to whatever makes more sense for the context. It's important to note
9595

96-
:::note
96+
::: warning
9797
All of the properties that can be defined on the Ref are defined as [non-enumerable properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty) which means they won't be copied over when using the spread operator e.g. `const { data, ...rest } = useDocument(contactSource)`. This is to ensure they are completely ignored in other places like devtools.
9898
:::
9999

@@ -299,7 +299,7 @@ Note this is only a type annotation, it does not perform any runtime validation.
299299

300300
The recommended Firebase approach is to use the `withConverter()` for Firestore:
301301

302-
:::info
302+
::: info
303303
`.withConverter()` is a Firestore feature that doesn't have an equivalent in Database but you can use VueFire's [`serialize()` option](#TODO:global options when installing plugin) instead.
304304
:::
305305

docs/guide/ssr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Server Side Rendering (SSR)
22

33
<!-- NOTE: hide until it works -->
4-
<!-- :::tip
4+
<!-- ::: tip
55
If you are using Nuxt.js, read the [Nuxt guide](./nuxt.md) instead, most of the things are already configured for you.
66
::: -->
77

docs/guide/upgrading-from-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Previously you would call `$firestoreBindAsArray` and `$firestoreBindAsObject` d
108108
}
109109
```
110110

111-
:::tip
111+
::: tip
112112
Note: you can pass an options object with `{ bindName: '$firestoreBind', unbindName: '$firestoreUnbind' }` to `Vue.use(VueFire)` to keep a shorter name for binding instead of `$rtdbBind` and `$rtdbUnbind`.
113113
:::
114114

0 commit comments

Comments
 (0)