lijunle / Vsxmd

VS XML documentation -> Markdown syntax.
MIT License
217 stars 52 forks source link

Back-to-content fails in GIT-flavored markdown #20

Closed aguarino77 closed 9 years ago

aguarino77 commented 9 years ago

Hi, this is just to mention that [^](...) will fail to render in GIT-flavoured markdown, because it will be interpreted as an mathematical sign. (see attachemnt). It's not a serious problem, anyhow. screen shot 2015-09-29 at 15 21 28

My current fix is to find-replace with [<].

lijunle commented 9 years ago

Hi, are you using Github? Which application are you using?

aguarino77 commented 9 years ago

We have the repositories on an internal gitlab (it’s a git on premise), you can see it at gitlab.com http://gitlab.com/. Special MD features are explained at GitLab Flavored Markdown https://www.google.ch/url?sa=t&rct=j&q=&esrc=s&source=web&cd=2&cad=rja&uact=8&ved=0CCgQFjABahUKEwj2t97PrZzIAhVGOhQKHeytDQk&url=https://gitlab.com/gitlab-org/gitlab-ce/blob/6-4-stable/doc/markdown/markdown.md&usg=AFQjCNF3psBNH276q0782rYhp0A60gpBvQ&sig2=3QJ6BvAsdzcJRWamtPMatQ

On 29 Sep 2015, at 15:31, Junle Li notifications@github.com wrote:

Hi, are you using Github? Which application are you using?

— Reply to this email directly or view it on GitHub https://github.com/lijunle/Vsxmd/issues/20#issuecomment-144059229.

lijunle commented 9 years ago

I created a public snippet on GitLab.

I am sorry to say that, GitLab has it own anchor location parsing engine, which is not compatible with the standard one. Click on the anchors generated by Vsxmd will break the URL. :cry:

Are you using the anchor navigation feature provided by Vsxmd. I am thinking about adding a switch to opt-out the anchor navigation generation.

How do you think about this?

aguarino77 commented 9 years ago

Anchor navigation is really a cool feature. I think that optionally modifying to [<] instead of [#] will work. It’s less pretty, but working.

On 29 Sep 2015, at 15:49, Junle Li notifications@github.com wrote:

I created a public snippet https://gitlab.com/snippets/8990 on GitLab.

I am sorry to say that, GitLab has it own anchor location parsing engine, which is not compatible with the standard one. Click on the anchors generated by Vsxmd will break the URL.

Are you using the anchor navigation feature provided by Vsxmd. I am thinking about adding a switch to opt-out the anchor navigation generation.

How do you think about this?

— Reply to this email directly or view it on GitHub https://github.com/lijunle/Vsxmd/issues/20#issuecomment-144065983.

lijunle commented 9 years ago

OK, I am actually talking about another issue.

I understand that, each git hosting website has its own flavor Markdown syntax. That is a trivial change to make ^ to other characters.

But, another problem is, I have not tested the features on GitLab. So, I am doing feature testing on GitLab, and find a bigger problem - the anchors are not handled correctly in GitLab. If you click on a method, then look on the URL, it is changed to a wrong URL.

I need more time to investigate this problem and do round feature testing on GitLab.

aguarino77 commented 9 years ago

Sorry, I did not notice this. You are right, the links work, the URL is wrong. Let me know if I can help

On 29 Sep 2015, at 17:42, Junle Li notifications@github.com wrote:

OK, I am actually talking about another issue.

I understand that, each git hosting website has its own flavor Markdown syntax. That is a trivial change to make ^ to other characters.

But, another problem is, I have not tested the features on GitLab. So, I am doing feature testing on GitLab, and find a bigger problem - the anchors are not handled correctly in GitLab. If you click on a method, then look on the URL, it is changed to a wrong URL.

I need more time to investigate this problem and do round feature testing on GitLab.

— Reply to this email directly or view it on GitHub https://github.com/lijunle/Vsxmd/issues/20#issuecomment-144098025.

lijunle commented 9 years ago

Gitlab is using History.js for hash history management.

There is two related bugs reporting in History.js:

Quote from this comment:

Note that if yr hashbang deeplinks do not have a slash or dot character, it won't redirect.

lijunle commented 9 years ago

@aguarino77

I have released v1.1.0 to resolve these two problems.