-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Adapter-static documentation: Github pages #2135
Conversation
|
Example added |
packages/adapter-static/README.md
Outdated
... | ||
// Since your Github Pages' default url will be https://your-username.github.io/your-repo-name, | ||
// you'll have the change the basepaths. | ||
// Note that you may have to comment these in dev mode. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems like quite the caveat. I don't know if we'd want to promote this solution without making it a bit nicer to use first
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
paths are currently broken in dev mode. i'll try to review #2145 and then we can see if that changes the situation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
other option is to detect the dev environment:
const isProduction = process.env.NODE_ENV === 'production';
...
paths: {
base: isProduction ? "project_name" : "",
}
...
documentation concerning GitHub Pages.
I tweaked the language to remove that caveat — we can merge this once #2189 is merged |
Add documentation for publishing to Github pages with adapter-static.
Would an
adapter-gh-pages
be possible?