From 034eb5f900043d8b072f17acf183c657803f9b9f Mon Sep 17 00:00:00 2001 From: Miron Aseev Date: Sat, 28 Oct 2017 10:52:37 +0700 Subject: [PATCH] Fix rendering of the CONTRIBUTING page on Github --- CONTRIBUTING => CONTRIBUTING.md | 0 .../dottydoc/staticsite/MarkdownLinkVisitor.scala | 13 ++++++++----- docs/docs/contributing/getting-started.md | 2 +- 3 files changed, 9 insertions(+), 6 deletions(-) rename CONTRIBUTING => CONTRIBUTING.md (100%) diff --git a/CONTRIBUTING b/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING rename to CONTRIBUTING.md diff --git a/doc-tool/src/dotty/tools/dottydoc/staticsite/MarkdownLinkVisitor.scala b/doc-tool/src/dotty/tools/dottydoc/staticsite/MarkdownLinkVisitor.scala index 5216ee950675..7f0a7b93d55b 100644 --- a/doc-tool/src/dotty/tools/dottydoc/staticsite/MarkdownLinkVisitor.scala +++ b/doc-tool/src/dotty/tools/dottydoc/staticsite/MarkdownLinkVisitor.scala @@ -3,18 +3,21 @@ package dottydoc package staticsite import com.vladsch.flexmark.ast._ -import com.vladsch.flexmark.util.sequence.CharSubSequence -import model.{ Package, NonEntity, Val, Def, TypeAlias } +import com.vladsch.flexmark.util.sequence.{BasedSequence, CharSubSequence} +import model.{Def, NonEntity, Package, TypeAlias, Val} import dottydoc.util.MemberLookup object MarkdownLinkVisitor { private val EntityLink = """([^\.]+)(\.[^\.]+)*""".r def apply(node: Node, docs: Map[String, Package], params: Map[String, AnyRef]): Unit = - (new NodeVisitor( + new NodeVisitor( new VisitHandler(classOf[Link], new Visitor[Link] with MemberLookup { override def visit(node: Link): Unit = { + def isExternal(url: BasedSequence) = + url.startsWith("http") || url.startsWith("https") + val url = node.getUrl - if (url.endsWith(".md")) node.setUrl { + if (url.endsWith(".md") && !isExternal(url)) node.setUrl { url.subSequence(0, url.lastIndexOf('.')).append(".html") } else if (EntityLink.unapplySeq(url.toString).isDefined) { @@ -37,6 +40,6 @@ object MarkdownLinkVisitor { } } }) - )) + ) .visit(node) } diff --git a/docs/docs/contributing/getting-started.md b/docs/docs/contributing/getting-started.md index 4baf842720aa..90af47214f12 100644 --- a/docs/docs/contributing/getting-started.md +++ b/docs/docs/contributing/getting-started.md @@ -75,4 +75,4 @@ $ sbt ``` Before contributing to Dotty, we invite you to consult the -[Dotty Developer Guidelines](https://github.com/lampepfl/dotty/blob/master/CONTRIBUTING). +[Dotty Developer Guidelines](https://github.com/lampepfl/dotty/blob/master/CONTRIBUTING.md).