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

Fix obscure characters in docs #11679

Closed
wants to merge 1 commit into from
Closed

Conversation

danielzsh
Copy link

For whatever reason, the dashes render as obscure characters:
image
This pr aims to fix that :) (although I'm not sure how many more places this issue appears in)


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.

Copy link

changeset-bot bot commented Jan 19, 2024

⚠️ No Changeset found

Latest commit: 66fc8b1

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

@Conduitry
Copy link
Member

Hm. These should work, and I'm pretty sure it used to. I think I'd prefer to figure out what's going wrong with character encoding than to hide it by changing the character we're using.

@danielzsh
Copy link
Author

Hm, this stackoverflow article could be relevant?

@Rich-Harris
Copy link
Member

I bet this is somehow related to #11649 — we switched from using node:fs directly to using import.meta.glob and the new read function from $app/server

@danielzsh
Copy link
Author

danielzsh commented Jan 19, 2024

What's even weirder is that when the page is rendered locally via pnpm dev, the em dash renders fine; it just breaks in the actual build with pnpm build/pnpm preview for some reason.

@danielzsh
Copy link
Author

Using — instead of the actual em dash character does seem to work; however, I assume this is not ideal?

@tmarsik42
Copy link

tmarsik42 commented Jan 19, 2024

Seems like an encoding issue on file read? I've found out that the em dash (—) char is represented as three characters (â��), whose unicode codes correspond to the byte representation of the em dash, if it helps. I tried investigating the solution further but I still don't understand why it doesn't happen everytime (https://kit.svelte.dev/docs/routing is fine)

Snímek obrazovky 2024-01-19 v 9 33 30

Update:
When using import.meta.glob here files that are within assetsInlineLimit get base64d. Those are the ones that have these encoding problems.

Update 2:
One uncomplicated solution I could find relies on vite 5.1.0-beta.0 which provides assetsInlineLimit callback, where it will be possible to omit .md files or make a more refined filter. Simply adding

assetsInlineLimit: (file) => {
    return !file.endsWith('.md');
}

to vite's config.build works.
vitejs/vite#15366

@Rich-Harris
Copy link
Member

It's a bug in read, it sounds like we need more robust base64 decoding

@Rich-Harris
Copy link
Member

closing in favour of #11682 — thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants