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 broken escape sequences on FAQ and install pages #35

Merged
merged 1 commit into from
Jun 12, 2022

Conversation

Pokechu22
Copy link
Contributor

For the most part, text surrounded by backticks is automatically escaped, so the backslashes or HTML escapes were showing up on the page, which is confusing. For the FAQ page, I've removed the backslashes. For the install page, I've used the <var> element which is more semantically correct (and results in italic formatting); that's not directly exposed in markdown, so I had to use code tags instead of backticks.

I haven't tested this beyond confirming that the pages now appear correctly on GitHub.

Here's what the pages looked like before this fix:

image
image

For the most part, text surrounded by backticks is automatically escaped, so the backslashes or HTML escapes were showing up on the page, which is confusing. For the FAQ page, I've removed the backslashes. For the install page, I've used the var element which is more semantically correct (and results in italic formatting); that's not directly exposed in markdown, so I had to use code tags instead of backticks.
Copy link
Member

@ISSOtm ISSOtm left a comment

Choose a reason for hiding this comment

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

Thanks! I think the escapes for the angle brackets are holdovers from the Jekyll days.

@ISSOtm ISSOtm merged commit 644d9a9 into gbdev:master Jun 12, 2022
@Pokechu22
Copy link
Contributor Author

Hmm, it seems like <code> gets styled a bit differently from backticks:

image

It looks like it's getting treated as <pre><code>. But, eh, I think this is readable enough and it's definitely an improvement over what was there before.

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.

2 participants