diff --git a/README.md b/README.md index 6261a3f1..dfd36388 100755 --- a/README.md +++ b/README.md @@ -80,23 +80,23 @@ yarn add nuxt-page-generator-helper # or npm install nuxt-page-generator-helper ## Options -| Name | Type | Description | Default Value | Required | -| ------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | -------- | -| `debug` | `Boolean` | Debug-Mode | `false` | `false` | -| `dev` | `Boolean` | If set, modul is also active in development mode. | `false` | `false` | -| `adapter` | `Object` | Function for querying the page structure with Content. | `null` | `true` | -| `adapterOptions` | `Object` | Adapter to retrieve the payloads. Contains the calls `getRoute`, `getRoutes`, `getLayout` and path specification (`PATH`). | `null` | `true` | -| `pageExtend` | `Object` | Path to the page extension that is used during generation. | `null` | `true` | -| `componentPath` | `String` | Component src Path. Is required for embedding specified components in a page. | `@/components` | `false` | -| `componentPrefix` | `String` | Prefix for component imports in generated pages.
Example: Component `Text` -> Component `prefixText` | `prefix` | `false` | -| `asyncComponentLoad` | `Boolean` | When set, components of a page are loaded asynchronously. | `true` | `false` | -| `asyncComponentMaxEager` | `Number` | Specifies the number of components assigned to the page chunk.
Important: Only active if `asyncComponentLoad` is set. | `1` | `false` | -| `lazyHydrateEnable` | `Boolean` | Components that can be reloaded can be controlled with LazyHydration.
Example:
With the setting 'maxEagerComponents=1'
the first component is initialized at 'whenIdle'. All others at `whenVisible`.
[vue-lazy-hydration](https://github.com/maoberlehner/vue-lazy-hydration) | `true` | `false` | -| `lazyHydrateRootMargin` | `String` | Specifies when the `whenVisible` event is triggered.
Example:
Component initialization occurs,
Component is less than 80px away from the visible area. | `80px` | `false` | -| `routesCache` | `Boolean` | If active, the adapter result is stored locally. | `false` | `false` | -| `ignoreRoutes` | `Array` | List of route names, to be ignore by routes extend.
Example: `['index', 'page', 'nested-page']` | `null` | `true` | -| `cleanRoutes` | `Boolean` | If set, all already registered routes will be removed from the list. | `false` | `false` | -| `nuxtI18n` | `Object` | Configuration for nuxt-i18n | `null` | `true` | +| Name | Type | Description | Default Value | Required | +| ------------------------ | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | -------- | +| `debug` | `Boolean` | Debug-Mode | `false` | `false` | +| `dev` | `Boolean` | If set, modul is also active in development mode. | `false` | `false` | +| `adapter` | `Object` | Function for querying the page structure with Content. | `null` | `true` | +| `adapterOptions` | `Object` | Adapter to retrieve the payloads. Contains the calls `getRoute`, `getRoutes`, `getLayout` and path specification (`PATH`). | `null` | `true` | +| `pageExtend` | `Object` | Path to the page extension that is used during generation. | `null` | `true` | +| `componentPath` | `String` | Component src Path. Is required for embedding specified components in a page. | `@/components` | `false` | +| `componentPrefix` | `String` | Prefix for component imports in generated pages.
Example: Component `Text` -> Component `PrefixText` | `prefix` | `false` | +| `asyncComponentLoad` | `Boolean` | When set, components of a page are loaded asynchronously. | `true` | `false` | +| `asyncComponentMaxEager` | `Number` | Specifies the number of components assigned to the page chunk.
Important: Only active if `asyncComponentLoad` is set. | `1` | `false` | +| `lazyHydrateEnable` | `Boolean` | Components that can be reloaded can be controlled with LazyHydration.
Example:
With the setting `maxEagerComponents: 1,`
the first component is initialized at `whenIdle`. All others at `whenVisible`.
[vue-lazy-hydration](https://github.com/maoberlehner/vue-lazy-hydration) | `true` | `false` | +| `lazyHydrateRootMargin` | `String` | Specifies when the `whenVisible` event is triggered.
Example:
Component initialization occurs,
Component is less than `80px` away from the visible area. | `80px` | `false` | +| `routesCache` | `Boolean` | If active, the adapter result is stored locally. | `false` | `false` | +| `ignoreRoutes` | `Array` | List of route names, to be ignore by routes extend.
Example: `['index', 'page', 'nested-page']` | `null` | `true` | +| `cleanRoutes` | `Boolean` | If set, all already registered routes will be removed from the list. | `false` | `false` | +| `nuxtI18n` | `Object` | Configuration for nuxt-i18n | `null` | `true` | ## Build matrix of the page components generation @@ -115,7 +115,7 @@ yarn add nuxt-page-generator-helper # or npm install nuxt-page-generator-helper Adapter `local-json` is used to work with local `JSON` files. -[📖 Sources]([./example/adapter/local-json/README.md](https://github.com/GrabarzUndPartner/nuxt-page-generator-helper/tree/master/example/adapter/local-json)) +[📖 Sources](./example/adapter/local-json) ## Plugins @@ -149,7 +149,7 @@ this.$getGeneratorOptions() _**Coming Soon...**_ -> But you can have a look at the module example. [Example Direcotry](https://github.com/GrabarzUndPartner/nuxt-page-generator-helper/tree/master/example) +> But you can have a look at the module example. [Example Directory](./example) ## Preview