Skip to content

Commit 1598da1

Browse files
committed
Add configurable social links to scala3doc
1 parent c3e26df commit 1598da1

18 files changed

+129
-8
lines changed

project/Build.scala

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1624,6 +1624,9 @@ object Build {
16241624
"-skip-by-regex:.+\\.impl($|\\..+) " +
16251625
"-comment-syntax wiki -siteroot scaladoc/scala3-docs -project-logo scaladoc/scala3-docs/logo.svg " +
16261626
"-external-mappings:.*java.*::javadoc::https://docs.oracle.com/javase/8/docs/api/ " +
1627+
"-social-links:github::https://github.com/lampepfl/dotty," +
1628+
"gitter::https://gitter.im/scala/scala," +
1629+
"twitter::https://twitter.com/scala_lang " +
16271630
s"-source-links:$stdLibRoot=github://scala/scala/v${stdlibVersion(Bootstrapped)}#src/library " +
16281631
s"-doc-root-content $docRootFile"
16291632
))

scaladoc-js/src/Main.scala

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@ package dotty.tools.scaladoc
22

33
object Main extends App {
44
Searchbar()
5+
SocialLinks()
56
}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package dotty.tools.scaladoc
2+
3+
import org.scalajs.dom._
4+
import org.scalajs.dom.ext._
5+
6+
class SocialLinks:
7+
def addIcon(elem: html.Element) =
8+
val img = document.createElement("img").asInstanceOf[html.Image]
9+
img.src = s"${Globals.pathToRoot}images/${elem.getAttribute("data-icon-path")}"
10+
elem.appendChild(img)
11+
12+
document.querySelectorAll(".social-icon").collect { case e: html.Element => e }.foreach(addIcon)

scaladoc/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,3 +167,9 @@ Make sure all the tests pass (simply run `sbt test` to verify that).
167167
A documentation tool needs to access compiler information about the project - it
168168
needs to list all definitions, resolve them by name, and query their members.
169169
Tasty Reflect is the dedicated way in Scala 3 of accessing this information.
170+
171+
## Credits
172+
173+
- [Flatart](https://www.iconfinder.com/Flatart) - Gitter icon
174+
175+
1.52 KB
Loading
1.52 KB
Loading
1.67 KB
Loading
1.53 KB
Loading
386 Bytes
Loading
5.39 KB
Loading

0 commit comments

Comments
 (0)