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

Quotation marks in code blocks are converted to <q> tags #714

Closed
1ec5 opened this issue Dec 24, 2016 · 3 comments
Closed

Quotation marks in code blocks are converted to <q> tags #714

1ec5 opened this issue Dec 24, 2016 · 3 comments

Comments

@1ec5
Copy link
Collaborator

1ec5 commented Dec 24, 2016

jazzy automatically converts quotation marks inside code blocks into <q> tags. Though the code looks more sophisticated as a result, it doesn’t necessarily compile. For example, see the Mapbox iOS SDK’s MGLCircleStyleLayer documentation, which places a three-backtick code block in the class’s description to provide example code:

MGLCircleStyleLayer

If you copy-paste this example from Firefox, Firefox inserts straight quotation marks around each <q> tag, so the example works just fine. However, in Safari and Chrome, no quotation marks are inserted, so the code doesn’t compile.

This is part of the problem in #630, but there seems to be more going on there than just the <q> tags.

/cc @friedbunny @ericrwolfe

@1ec5
Copy link
Collaborator Author

1ec5 commented Jan 8, 2017

This looks to be some kind of weird interaction between rouge and redcarpet, but I can’t quite figure out what the issue is.

In the meantime, I came up with a workaround in mapbox/mapbox-gl-native#7629 that turns the <q> tags into plain text on page load using JavaScript. That PR is specific to the theme we’re using for the Mapbox iOS/macOS SDK documentation. @jpsim, would you accept a PR that works around the issue in similar fashion in the apple and fullwidth themes?

@jpsim
Copy link
Collaborator

jpsim commented Jan 10, 2017

Yeah, I think that's a worthwhile hack to get in place for others to use.

@johnfairh
Copy link
Collaborator

Underlying problem fixed by #628, workaround now removed in master.

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

No branches or pull requests

4 participants