Add Edit on Github button and Contriubuted sections

Author: BarkingBad

docs/_layouts/doc-page.html

@@ -3,12 +3,26 @@
 ---
 <main>
   <header>
+    <div class="byline">
+      <a href="{{ urls.editSource }}">
+      <i class="far fa-edit"></i>
+      Edit this page on GitHub
+    </a>
+    </div>
     <h1>{{ page.title }}</h1>
   </header>
   {{ content }}
   <div class="two-columns">
-    <a href="{{ page.previous }}">← <strong>previous</strong></a>
-    <a href="{{ page.next }}"><strong>next</strong> →</a>
+    {% if page.previous %}
+      <a href="{{ page.previous }}">← <strong>previous</strong></a>
+    {% endif %}
+    {% if page.next %}
+      <a href="{{ page.next }}"><strong>next</strong> →</a>
+    {% endif %}
+  </div>
+  <div class="content-contributors">
+    <h3>Contributors to this page:</h3>
+    <div id="contributors" class="contributors-container"></div>
   </div>
 </main>
 

docs/_layouts/main.html

@@ -29,12 +29,6 @@
         </nav>
       </div>
     </header>
-
-    {% if page.movedTo %}
-    <aside class="warning">
-      The content of this page is outdated. Click <a href="{{ page.movedTo }}">here</a> to find the up to date version of this page.
-    </aside>
-    {% endif %}
     {{ content }}
   </div>
 </div>

project/Build.scala

@@ -1321,7 +1321,7 @@ object Build {
         Seq(jsDestinationFile)
       }.taskValue,
       Compile / resourceGenerators += Def.task {
-        Seq("code-snippets.css", "searchbar.css", "social-links.css", "ux.css", "versions-dropdown.css").map { file =>
+        Seq("code-snippets.css", "searchbar.css", "content-contributors.css", "social-links.css", "ux.css", "versions-dropdown.css").map { file =>
           val cssDesitnationFile = (Compile / resourceManaged).value / "dotty_res" / "styles" / file
           val cssSourceFile = (`scaladoc-js` / Compile / resourceDirectory).value / file
           sbt.IO.copyFile(cssSourceFile, cssDesitnationFile)

scaladoc-js/resources/content-contributors.css

@@ -0,0 +1,20 @@
+.content-contributors .contributors-container {
+  display: flex;
+  flex-wrap: wrap;
+  align-items: center;
+}
+.content-contributors .contributors-container div {
+  margin: 5px;
+}
+.content-contributors .contributors-container div a {
+  vertical-align: middle;
+  padding: 3px;
+  text-decoration: none;
+}
+.content-contributors .contributors-container div img {
+  vertical-align: middle;
+  width: 35px;
+  height: 35px;
+  margin-bottom: 0;
+  border-radius: 7px;
+}

scaladoc-js/src/Main.scala

@@ -10,6 +10,7 @@ object Main:
     SocialLinks()
     DropdownHandler()
     Ux()
+    ContentContributors()
     common()
 
   /**

scaladoc-js/src/content-contributors/ContentContributors.scala

@@ -0,0 +1,74 @@
+package dotty.tools.scaladoc
+
+import org.scalajs.dom._
+import org.scalajs.dom.ext._
+
+import scala.util.matching.Regex._
+import scala.util.matching._
+import org.scalajs.dom.ext.Ajax
+import scala.scalajs.js.JSON
+import scala.scalajs.js
+
+import scala.concurrent.ExecutionContext.Implicits.global
+import scala.concurrent.Future
+import scala.util.{Success,Failure}
+
+// Contributors widget
+// see https://stackoverflow.com/a/19200303/4496364
+// Copied from https://github.com/scala/docs.scala-lang/blob/main/resources/js/functions.js and rewritten to Scala.js
+
+case class FullAuthor(name: String, url: String, image: String)
+
+trait FallbackAuthor extends js.Object:
+  def name: String
+
+trait CommitBottom extends js.Object:
+  def author: FallbackAuthor
+
+trait Author extends js.Object:
+  def login: String
+  def avatar_url: String
+  def html_url: String
+
+trait CommitTop extends js.Object:
+  def commit: CommitBottom
+  def author: Author
+
+trait Commits extends js.Array[CommitTop]
+
+class ContentContributors:
+  document.addEventListener("DOMContentLoaded", (e: Event) => {
+    val githubApiUrl = "https://api.github.com/repos/lampepfl/dotty/commits"
+    val indenticonsUrl = "https://github.com/identicons"
+    val thisPageUrl = document.querySelector(".byline a").asInstanceOf[html.Anchor].href
+      .stripPrefix("https://github.com/lampepfl/dotty/edit/master/")
+    val url = s"$githubApiUrl?path=$thisPageUrl"
+    val request: Future[String] = Ajax.get(url).map(_.responseText)
+    request.onComplete {
+      case Success(json: String) =>
+        val res = JSON.parse(json).asInstanceOf[Commits]
+        val authors = res.map { commit =>
+          commit.author match
+            case null =>
+              FullAuthor(commit.commit.author.name, "", s"$indenticonsUrl/${commit.commit.author.name}.png")
+            case author =>
+              FullAuthor(author.login, author.html_url, author.avatar_url)
+        }.distinct
+
+        val div = document.getElementById("contributors")
+        authors.foreach { case FullAuthor(name, url, img) =>
+          val divN = document.createElement("div")
+          val imgN = document.createElement("img").asInstanceOf[html.Image]
+          imgN.src = img
+          val autN = document.createElement("a").asInstanceOf[html.Anchor]
+          autN.href = url
+          autN.text = name
+          divN.appendChild(imgN)
+          divN.appendChild(autN)
+          div.appendChild(divN)
+        }
+      case Failure(_) =>
+        println(s"Couldn't fetch contributors for $url")
+    }
+  })
+