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

Direct scaladoc links #119

Merged
merged 2 commits into from
May 18, 2017
Merged

Conversation

jonas
Copy link
Contributor

@jonas jonas commented May 17, 2017

jonas added 2 commits May 18, 2017 01:31
Since at least Scala 2.10, Scaladoc redirects to the framed version
automatically when visiting the page directly. Linking directly to the
page helps SEO, is friendly to crawlers, and also works when javascript
is disabled. Finally, Scala 2.10, 2.11 and 2.12 links can be generated
the same way.
}

it should "handle method links correctly" in {
markdown("@scaladoc[???](scala.Predef$@???:Nothing)") shouldEqual
html("""<p><a href="http://www.scala-lang.org/api/2.11.8/#scala.Predef$@???:Nothing">???</a></p>""")
markdown("@scaladoc[???](scala.Predef$#???:Nothing)") shouldEqual
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note this changes the URLs for linking to methods.

Copy link
Member

@pvlugter pvlugter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pvlugter pvlugter merged commit 5fe342d into lightbend:master May 18, 2017
@jonas jonas deleted the direct-scaladoc-links branch May 22, 2017 08:33
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