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.

Sign up for GitHub

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

Jump to bottom

Documentation links are not working when viewed from GitHub #327

Closed
jeromelaban opened this issue Nov 5, 2018 · 2 comments
Closed

Documentation links are not working when viewed from GitHub #327

jeromelaban opened this issue Nov 5, 2018 · 2 comments
Assignees
@nv-ksavaria
Labels
kind/bug Something isn't working

Comments

@jeromelaban
Copy link
Member

I'm submitting a...

  • Documentation

Current behavior

Links from https://github.com/nventive/Uno/blob/master/doc/index.md are not working when viewed on GitHub.

Expected behavior

Should work for both the docs generated site, and GitHub.
@jeromelaban jeromelaban added the kind/bug Something isn't working label Nov 5, 2018
@nv-ksavaria nv-ksavaria mentioned this issue Nov 5, 2018
Merged
5 tasks
@jeromelaban
Copy link
Member Author

It does not seem to generate a proper link, the ~ works, but the link needs to be a .md not an .html. Is there a way for docfx to detect that in a link ?

@nv-ksavaria
Copy link
Collaborator

I changed the links markup to MD syntax, which is converted to html markup on docfx build. Seems to do the trick.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nv-ksavaria nv-ksavaria

Labels
kind/bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jeromelaban @nv-ksavaria