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

class diagram not rendered in sites #1438

Closed
kailuowang opened this issue Oct 26, 2016 · 5 comments
Closed

class diagram not rendered in sites #1438

kailuowang opened this issue Oct 26, 2016 · 5 comments
Assignees

Comments

@kailuowang
Copy link
Contributor

The type class diagram isn’t rendering correctly in microsites
It’s renderred correctly in github:
https://github.com/typelevel/cats/blob/master/docs/src/main/tut/typeclasses/typeclasses.md
But the markdown is simply displayed as plain text here in the site
http://typelevel.org/cats/typeclasses.html
cc @juanpedromoreno I wonder if you happen to have some clue off the top of your head.

@juanpedromoreno
Copy link
Contributor

Oops, we could tackle it in one of these ways:

http://pother.ca/StackOverflow/question.13808020.include-an-svg-hosted-on-github-in-markdown/

@kailuowang Would be any of those alternatives valid?

@kailuowang
Copy link
Contributor Author

kailuowang commented Oct 27, 2016

@juanpedromoreno thanks! I am not sure I understand the cause of this problem. The question you posted, it seems to me, is about github serving text based file with text content type. In our case the svg is served by a 3rd part service gravizo.com, which shouldn't have the content type problem. In our case, I think jekyll didn't render the ![XXX](http://....) into an image tag, rather, it just render it as plain text. Could it be related to the embedded dot language in the url?

@kailuowang
Copy link
Contributor Author

I found out a cause some entries has quotes in name. e.g. "functor.Invariant", without the ", the . will break the entry name. However this seems broke the jekyll rendering, if I replace all quoted entry with a single word, the diagram works, e.g. change from "functor.Invariant" to Invariant. So the solution I think we can take is to use a label functor for that sub group instead of using functor.Invariant and functor.Contravariant

@kailuowang kailuowang self-assigned this Oct 27, 2016
@non non closed this as completed in f384fc9 Oct 27, 2016
non added a commit that referenced this issue Oct 27, 2016
Fixes #1438 by replacing quoted entry name
@non non removed the in progress label Oct 27, 2016
@juanpedromoreno
Copy link
Contributor

Oops, sorry for the late answer, good to know that the issues were resolved.

Thanks @kailuowang

@kailuowang
Copy link
Contributor Author

@juanpedromoreno no problem. Thanks again for your tremendous contribution to cats' site. Everybody loves it.

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

3 participants