Skip to content

Commit 2efc355

Browse files
docs: enhancements (#592)
* docs: enclose vue-meta in backticks * docs: add correct link to Factor * docs: enclose metaInfo and keyName in backticks * docs: fix typo
1 parent 8bb5176 commit 2efc355

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

docs/guide/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For the latest version in the v1.x branch you can use:<br/>
1414

1515
Or you can replace `1` with the full version number you wish to use.
1616

17-
If you include vue-meta after Vue it will install automatically
17+
If you include `vue-meta` after Vue it will install automatically
1818

1919
**Unminified (suggested only for dev):**
2020
```html
@@ -41,7 +41,7 @@ $ npm i vue-meta
4141

4242
:::warning Using a framework?
4343

44-
If you use a framework like Nuxt.js or Gridsome, vue-meta comes pre-installed and this step is most likely **not** required. Consult the [documentation](/guide/frameworks.html) of your framework for more information
44+
If you use a framework like Nuxt.js or Gridsome, `vue-meta` comes pre-installed and this step is most likely **not** required. Consult the [documentation](/guide/frameworks.html) of your framework for more information
4545
:::
4646

4747
If you add `vue-meta` with a package manager, you will need to install the `vue-meta` plugin manually:

docs/guide/caveats.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ _Corresponding issue_: [#404](https://github.com/nuxt/vue-meta/issues/404)
4848
Please read [Multiple Vue apps support](/guide/multiple-apps.html#ssr) as a prerequisite
4949
:::
5050

51-
To optimize performance, VueMeta will only initialize for a Vue app when it finds a metaInfo property on any of the loaded components. That means if you render all your components by passing the component instance directly to the render function, Vue will only know of these components once the app gets mounted (see snippet below). And this means VueMeta is unable to find any metaInfo when it looks if its need to initialize in the `beforeCreate` hook and the appId will not be changed to the [ssrAppId](/api#ssrappid)
51+
To optimize performance, VueMeta will only initialize for a Vue app when it finds a `metaInfo` property on any of the loaded components. That means if you render all your components by passing the component instance directly to the render function, Vue will only know of these components once the app gets mounted (see snippet below). And this means VueMeta is unable to find any `metaInfo` when it looks if its need to initialize in the `beforeCreate` hook and the appId will not be changed to the [ssrAppId](/api#ssrappid)
5252

5353
```js
5454
/* this is an example of when metaInfo will only become available once the
@@ -68,7 +68,7 @@ export default App {
6868
};
6969
```
7070

71-
This will result in all the metaInfo properties of your ssr app to be rendered twice, once with [ssrAppId](/api#ssrappid) and once with appId `1`.
71+
This will result in all the `metaInfo` properties of your ssr app to be rendered twice, once with [ssrAppId](/api#ssrappid) and once with appId `1`.
7272

73-
To prevent this, either make sure there is any metaInfo configured (on any component) when the `beforeCreate` hook runs. Alternative (but not recommended) you could set [ssrAppId](/api#ssrappid) to `1` as well.
73+
To prevent this, either make sure there is any `metaInfo` configured (on any component) when the `beforeCreate` hook runs. Alternative (but not recommended) you could set [ssrAppId](/api#ssrappid) to `1` as well.
7474

docs/guide/frameworks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ Proceed to the [Vue-Storefront documentation](https://docs.vuestorefront.io/)
2020

2121
## Factor
2222

23-
Proceed to the [Factor documentation](https://factor.dev/guide/meta)
23+
Proceed to the [Factor documentation](https://factor.dev/docs/metainfo)

docs/guide/metainfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ You can define a `[keyName]` property in any of your components, by default this
55
See the [API](/api) for a list of recognised `metaInfo` properties
66

77
::: tip Note
8-
Altough we talk about the `metaInfo` variable on this page, please note that the keyName is [configurable](/api/#keyname) and could be different in your case. E.g. [Nuxt.js](https://nuxtjs.org/api/pages-head#the-head-method) uses `head` as keyName
8+
Although we talk about the `metaInfo` variable on this page, please note that the `keyName` is [configurable](/api/#keyname) and could be different in your case. E.g. [Nuxt.js](https://nuxtjs.org/api/pages-head#the-head-method) uses `head` as `keyName`
99
:::
1010

1111
**App.vue:**

0 commit comments

Comments
 (0)