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: update adapter static doc for github page deployment #13302

Merged
merged 0 commits into from
Jan 13, 2025

Conversation

mengxi-ream
Copy link

@mengxi-ream mengxi-ream commented Jan 13, 2025


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

The document solved the problem that people can't see css in their github page deployment with static adapter
https://www.reddit.com/r/sveltejs/comments/w30mty/not_showing_any_css_styling_when_hosted_as_static/

Copy link

changeset-bot bot commented Jan 13, 2025

⚠️ No Changeset found

Latest commit: 417f028

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

@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-kit-13302-svelte.vercel.app/

this is an automated message

@@ -170,4 +170,4 @@ jobs:
uses: actions/deploy-pages@v4
```

If you're not using GitHub actions to deploy your site (for example, you're pushing the built site to its own repo), add an empty `.nojekyll` file in your `static` directory to prevent Jekyll from interfering.
If you're not using GitHub actions to deploy your site (for example, you're pushing the built site to its own repo), add an empty `.nojekyll` file in your `static` directory to prevent Jekyll from interfering. If you use `gh-pages` to push the build folder to your repository, you need to add the `-t` option to the command `npx gh-pages -d build -t` to include dot files (e.g., `.nojekyll`) in your build branch.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you're not using GitHub actions to deploy your site (for example, you're pushing the built site to its own repo), add an empty `.nojekyll` file in your `static` directory to prevent Jekyll from interfering. If you use `gh-pages` to push the build folder to your repository, you need to add the `-t` option to the command `npx gh-pages -d build -t` to include dot files (e.g., `.nojekyll`) in your build branch.
If you're not using GitHub actions to deploy your site (for example, you're pushing the built site to its own repo), add an empty `.nojekyll` file in your `static` directory to prevent Jekyll from interfering. Alternatively, if you're using the [`gh-pages`](https://www.npmjs.com/package/gh-pages) cli, you should add the `--nojekyll` flag.

Slight tweak to use this option instead, as may reduce accidentally committing a dotfile you didn't intend

@eltigerchino eltigerchino added the documentation Improvements or additions to documentation label Jan 13, 2025
@benmccann benmccann merged commit c2ffdcf into sveltejs:main Jan 13, 2025
16 checks passed
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.

5 participants