Jazzy ignores markup inside double quotes?

[iDave2]

Hi all,

I just installed jazzy 0.9.3 using Xcode 9.4.1 command-line toolset, then returned to Xcode 10.0 beta 2 environment where my project lives. (Jazzy would not install with the 10.0 tools.)

I am seeing the following in case it is helpful:

1. Jazzy ignores markup inside "double-quoted text" while Quick Help handles this fine.

2. Both jazzy and quick help respect markup 'inside single quotes' (so grammatically odd but a temporary workaround).

3. Jazzy handles ``TeX-like quotes'' nicely but Xcode is clueless about these.

Also tried on small 9.4.1 project and toolset, same result.

Regards,
Dave.

[SDGGiesbrecht]

I’m not sure about the issue itself, or what the Markup standard is. It all needs looking into.

But first, because I simply cannot resist... 😜

---

I suspect actually using quotation marks would avoid the issue completely:

Text	Unicode Scalars	American macOS Keyboard
“...”	U+201C, U+201D	⌥[, ⇧⌥[
‘...’	U+2018, U+2019	⌥], ⇧⌥]

If you cannot find or remember where they are on your keyboard, you can also use these characters with copy and paste, the character palette, snip‐its, text replacement or a custom keyboard layout.

Find and replace can be helpful for fixing a file full of ASCII’s teleprinter approximates.

Not only do they look better, but the make many things simpler. For example, say goodbye to escape sequences:

print("In about 1910, a new device called a \"typewriter\" had limited space.")
print("But these marks, called “quotation marks,” were around long before Gutenberg’s press.")

[iDave2]

A plethora of workarounds.

I'm still voting for keyboard quotes. ;)

[SDGGiesbrecht]

A plethora of workarounds.

I'm still voting for keyboard quotes. ;)

[amused laughter] They are themselves a workaround—100 years have passed and your keyboard still hasn’t been fixed.

But anyway, it was never my intent to suggest that Jazzy has an excuse for tripping up like that. It does need fixing.

[johnfairh]

The issue here is about something like "cut the *red* wire". Jazzy displays the asterisks literally instead of applying <strong>. Other markdown renderers, quick help in particular, do the italics.

This turns out to be because we are passing the quote option to Redcarpet. This makes Redcarpet emit <q> tags and whatever is between double-quotes verbatim.

Without the quote option, we end up with “ and ” entities and the markup honoured.

I think we should change this, even though it's long-standing behaviour: I understand the semantic/accessibility nature of <q> but for our purposes and compatibility with Xcode it's worth it.

The TeX-like quotes are a Redcarpet/CMark difference for once in our favour.

[jpsim]

I think we should change this, even though it's long-standing behaviour: I understand the semantic/accessibility nature of <q> but for our purposes and compatibility with Xcode it's worth it.

The TeX-like quotes are a Redcarpet/CMark difference for once in our favour.

👍 I'm in favor of this.