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 formatting in Latex layer README.org #12704

Closed
wants to merge 0 commits into from

Conversation

jonasws
Copy link

@jonasws jonasws commented Sep 6, 2019

This PR fixes a typo in the Latex layer README.org file, which caused the preview at http://develop.spacemacs.org/layers/+lang/latex/README.html to be off.

@duianto
Copy link
Contributor

duianto commented Sep 6, 2019

The zero width space character (shortened to ZWS below) was added in several places with this PR:
Fix inline code blocks #5305

I'm guessing that it's a workaround to show the key bindings without the surrounding ~ (tilde) characters. And that works on GitHub:
https://github.com/syl20bnr/spacemacs/tree/6031fe2a41356033af759c400956eed4979743b2/layers/%2Blang/latex#key-bindings

When this PR is applied, then the tilde characters appear again. This can be seen on your fork:
https://github.com/syl20bnr/spacemacs/blob/36da2737b2b499b7c595fa3fb12bd49b7fb037c9/layers/%2Blang/latex/README.org

You linked to the Spacemacs Latex layers develop branch web page:
http://develop.spacemacs.org/layers/+lang/latex/README.html
Where the tilde characters are visible, even though they also include the ZWS character.
(To view the html in google chrome, right click on the key binding and choose Inspect)

Now that I checked the Spacemacs Latex layers master branch web page:
http://spacemacs.org/layers/+lang/latex/README.html
the tilde characters aren't visible there, even though the ZWS characters are present there as well.

I'll let the maintainers know that the workaround isn't working on the develop branch web page.

A possible cause

It seems like Github isn't handling a comma or single quote before or after a tilde character in an .org file.

On Github

In your fork (without the ZWS character):
https://github.com/syl20bnr/spacemacs/blob/36da2737b2b499b7c595fa3fb12bd49b7fb037c9/layers/%2Blang/latex/README.org
~SPC m ,~ is rendered as: <td>~SPC m ,~</td>, (which shows the tilde characters)

The dash key binding on the line above does not show the tilde characters,
~SPC m -~ is rendered as <td><code>SPC m -</code></td>
~ has been converted to <code> and </code> (as expected).

The workaround on the Github Spacemacs Latex layer page:
https://github.com/syl20bnr/spacemacs/tree/6031fe2a41356033af759c400956eed4979743b2/layers/%2Blang/latex#key-bindings
adds a ZWS character between the comma and tilde:
~SPC m ,~ is rendered as <td><code>SPC m &#8203;,&#8203;</code></td>
That causes Github to render the tilde characters as <code>.

(On the Spacemacs develop branch there's an extra ZWS before the comma, it can be removed.)

On the Spacemacs web pages

The master branch:
http://spacemacs.org/layers/+lang/latex/README.html#keybindings
renders the key binding as:
<td class="org-left"><code>SPC m &#8203;,&#8203;</code></td> (<code> instead of ~)

The develop branch:
http://develop.spacemacs.org/layers/+lang/latex/README.html#key-bindings
renders it as:
<td class="org-left">~SPC m &#8203;,&#8203;~</td>

A possible solution

If the issue is fixed on Github's side then the workaround ZWS characters can be removed.

Could you report it to Github? It might help if someone else also reports it, you can link to this issue if you want. There's a Contact GitHub link at the bottom of this page.

@jonasws
Copy link
Author

jonasws commented Sep 6, 2019

Thanks for the heads up! I figured it had to do with alignment within the org-mode syntax definitions, but maybe not. I'll look into having it reported as a bug to GitHub!

EDIT: I reported this issue to GitHub. Fingers orssed!

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