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

Anchors in README not working – plugin not covering GitHub rendering? #92

Open
keikoro opened this issue Oct 16, 2016 · 3 comments
Open

Comments

@keikoro
Copy link
Contributor

keikoro commented Oct 16, 2016

Hey, I was about to check out your plugin when I noticed that the anchors in your README.rst file here on GitHub don't work. Apparently this is due to different RST > HTML rendering behaviour of GitHub. (I'm not really familiar with RST yet but that's what I got from this Stackoverflow answer to a question about cross-references.)

I was going to suggest to fix this if the code isn't hosted anywhere else more important, but realised just now that... if your .rst file does not render correctly on here, this might mean that I cannot actually use your plugin to preview RST files to see how they will appear on GitHub?

This would be interesting/relevant to know because the only reason I looked for RST plugins for Sublime in the first place was that I wanted to be able to preview how RST files would show up on GitHub.

@keikoro
Copy link
Contributor Author

keikoro commented Oct 16, 2016

Update: it looks like some anchors do work. Anchors that don't work are e.g. "preview rendering" in the Install section or "Header completion" in Usage.

@keikoro
Copy link
Contributor Author

keikoro commented Oct 16, 2016

Soooo, it took me ages to get a file to preview (btw. the README fails to mention that e.g. Pandoc can be added to one's PATH simply by adding a variable to the plugin's user settings) and it looks like anchors don't get rendered at all but show up as regular text.

Screenshot shows a portion of the README that has both anchors that work and don't work here on GH.

screen shot 2016-10-16 at 16 32 04

@keikoro
Copy link
Contributor Author

keikoro commented Oct 16, 2016

@mgaitan Before this gets lost: are there any plans to include rendering for a) anchors and b) RST how it appears on GitHub specifically? (See my original question above.)

@mgaitan mgaitan reopened this Oct 17, 2016
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

No branches or pull requests

2 participants