Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] additional clarification about createIndexFiles: false #3761

Closed
wants to merge 1 commit into from

Conversation

benmccann
Copy link
Member

closes #3725

@benmccann benmccann added the documentation Improvements or additions to documentation label Feb 7, 2022
@changeset-bot
Copy link

changeset-bot bot commented Feb 7, 2022

⚠️ No Changeset found

Latest commit: 5eaafcf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@netlify
Copy link

netlify bot commented Feb 7, 2022

✔️ Deploy Preview for kit-demo canceled.

🔨 Explore the source changes: 5eaafcf

🔍 Inspect the deploy log: https://app.netlify.com/sites/kit-demo/deploys/62015ff630e8a00007043a8a

@Rich-Harris
Copy link
Member

This realisation is a few days too late, but kit.prerender.createIndexFiles is the wrong option. It belongs to adapter-static, not to Kit itself (other adapters might want to set it depending on the value of trailingSlash). We should fix that instead of changing the docs

@Rich-Harris
Copy link
Member

#3799

@iham
Copy link

iham commented Feb 11, 2022

@Rich-Harris good point!
having the hint how to deal with endpoints /a-page converted to a-page.html when using createIndexFiles is set to false would be nice.

some mentioning that this can be a thing to setup in your webserver or some services already do it that way (like gh-pages)

my local nginx used for testing needs to be configured correctly to deal with that using try_files $uri $uri.html $uri/index.html =404; for example.

@benmccann benmccann closed this Feb 11, 2022
@benmccann benmccann deleted the createIndexFiles-docs branch February 11, 2022 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update hrefs to match with createIndexFiles set to false
3 participants