Skip to content

Commit

Permalink
sync docs to createIndexFiles (#3617)
Browse files Browse the repository at this point in the history
  • Loading branch information
ignatiusmb authored Jan 29, 2022
1 parent e794596 commit f4adea1
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .changeset/modern-pillows-beam.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
'@sveltejs/kit': patch
---

add prerender.subfolders setting
add `prerender.createIndexFiles` option
4 changes: 2 additions & 2 deletions documentation/docs/14-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ const config = {
prerender: {
concurrency: 1,
crawl: true,
createIndexFiles: true,
enabled: true,
subfolders: true,
entries: ['*'],
onError: 'fail'
},
Expand Down Expand Up @@ -195,9 +195,9 @@ See [Prerendering](#page-options-prerender). An object containing zero or more o

- `concurrency` — how many pages can be prerendered simultaneously. JS is single-threaded, but in cases where prerendering performance is network-bound (for example loading content from a remote CMS) this can speed things up by processing other tasks while waiting on the network response
- `crawl` — determines whether SvelteKit should find pages to prerender by following links from the seed page(s)
- `createIndexFiles` - if set to `false`, will render `about.html` instead of `about/index.html`
- `enabled` — set to `false` to disable prerendering altogether
- `entries` — an array of pages to prerender, or start crawling from (if `crawl: true`). The `*` string includes all non-dynamic routes (i.e. pages with no `[parameters]` )
- `subfolders` - set to `false` to disable subfolders for routes: instead of `about/index.html` render `about.html`
- `onError`

- `'fail'` — (default) fails the build when a routing error is encountered when following a link
Expand Down
2 changes: 1 addition & 1 deletion packages/kit/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- Move config.kit.hydrate and config.kit.router to config.kit.browser ([#3578](https://github.com/sveltejs/kit/pull/3578))

* add prerender.subfolders setting ([#2632](https://github.com/sveltejs/kit/pull/2632))
* add `prerender.createIndexFiles` option ([#2632](https://github.com/sveltejs/kit/pull/2632))

## 1.0.0-next.249

Expand Down

0 comments on commit f4adea1

Please sign in to comment.