Skip to content

Commit d453b0e

Browse files
committed
Fix API after rebase conflicts
1 parent eb72ec3 commit d453b0e

File tree

4 files changed

+27
-10
lines changed

4 files changed

+27
-10
lines changed

project/Build.scala

+1-1
Original file line numberDiff line numberDiff line change
@@ -1367,7 +1367,7 @@ object Build {
13671367
Seq(inkuireDestinationFile)
13681368
}.taskValue,
13691369
libraryDependencies ++= Dependencies.flexmarkDeps ++ Seq(
1370-
"nl.big-o" % "liqp" % "0.6.7",
1370+
"nl.big-o" % "liqp" % "0.6.8",
13711371
"org.jsoup" % "jsoup" % "1.13.1", // Needed to process .html files for static site
13721372
Dependencies.`jackson-dataformat-yaml`,
13731373

project/scripts/genDocsScalaLang

+9-5
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ git clone "https://github.com/scala/docs.scala-lang.git" $DOCS_SCALA_LANG_DIR
1919
SBT="$SCRIPT_DIR/sbt"
2020
mkdir -pv $SITE_OUT_DIR
2121
env "scaladoc.projectFormat=md" "$SBT" "scaladoc/renderScaladocScalajsToFile $DOCS_SCALA_LANG_DIR/scripts/scaladoc-scalajs.js $DOCS_SCALA_LANG_DIR/resources/css code-snippets.css"
22-
"dist/target/pack/bin/scaladoc" "-d" "$SITE_OUT_DIR" "-format" "md" "-siteroot" "docs" "/dev/null"
22+
"bin/scaladoc" "-d" "$SITE_OUT_DIR" "-format" "md" "-siteroot" "docs" "/dev/null"
2323

2424
if [ ! -d "$SITE_OUT_DIR" ]; then
2525
echo "Output directory did not exist: $SITE_OUT_DIR" 1>&2
@@ -30,12 +30,9 @@ fi
3030
cp -rf "$SITE_OUT_DIR/docs/reference"/* "$DOCS_SCALA_LANG_DIR/_scala3-reference"
3131
cp -rf "$SITE_OUT_DIR/docs/usage/scaladoc"/* "$DOCS_SCALA_LANG_DIR/_overviews/scala3-scaladoc"
3232

33-
cp -rf "$SITE_OUT_DIR/docs/reference/contextual/motivation.md" "$DOCS_SCALA_LANG_DIR/_scala3-reference/contextual.md"
34-
cp -rf "$SITE_OUT_DIR/docs/reference/metaprogramming/toc.md" "$DOCS_SCALA_LANG_DIR/_scala3-reference/metaprogramming.md"
3533
cp -rf "$SITE_OUT_DIR/docs/resources/talks.md" "$DOCS_SCALA_LANG_DIR/scala3/talks.md"
3634
cp -rf "$SITE_OUT_DIR/docs/usage/getting-started.md" "$DOCS_SCALA_LANG_DIR/scala3/getting-started.md"
37-
cp -rf "$SITE_OUT_DIR/docs/usage/language-versions.md" "$DOCS_SCALA_LANG_DIR/_scala3-reference/language-versions.md"
38-
cp -rf "$SITE_OUT_DIR/docs/usage/worksheet-mode.md" "$DOCS_SCALA_LANG_DIR/_overviews/scala3-book/tools-worksheets.md"
35+
cp -rf "$SITE_OUT_DIR/docs/usage/tools-worksheets.md" "$DOCS_SCALA_LANG_DIR/_overviews/scala3-book/tools-worksheets.md"
3936

4037

4138
# Copy csses and html importing these assets
@@ -44,3 +41,10 @@ cp -f "$PWD/docs/docsScalaLangResources/scaladoc-assets.html" "$DOCS_SCALA_LANG_
4441

4542
# Hack inclusion of these assests by the docs.scala-lang jekyll builder
4643
echo "{% include scaladoc-assets.html %}" >> "$DOCS_SCALA_LANG_DIR/_layouts/inner-page-parent-dropdown.html"
44+
45+
# Push changes to fork branch
46+
cd $DOCS_SCALA_LANG_DIR
47+
git remote add barkingbad [email protected]:BarkingBad/docs.scala-lang.git
48+
git add .
49+
git commit -m "Update docs from dotty repo"
50+
git push -f barkingbad main:pregenerated-page

scaladoc/src/dotty/tools/scaladoc/site/FrontMatterRenderer.scala

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ object FrontMatterRenderer:
99
def render(properties: Map[String, Object]): String =
1010

1111
def renderProperties(newProps: Map[String, Object]): List[String] = newProps.collect {
12-
case (k: String, v: String) => s"$p: $v"
13-
}
12+
case (k: String, v: String) => s"$k: $v"
13+
}.toList
1414

15-
val rows = renderProperties(properties) ++ renderProperties(properties("page"))
15+
val rows = renderProperties(properties) ++ renderProperties(properties("page").asInstanceOf[Map[String, Object]])
1616

1717
rows.mkString("---\n", "\n", "\n---") + "\n\n<!-- THIS FILE HAS BEEN GENERATED BY SCALADOC PREPROCESSOR. " +
1818
"NOTE THAT ANY CHANGES TO THIS FILE CAN BE OVERRIDEN IN THE FUTURE -->\n\n"

scaladoc/src/dotty/tools/scaladoc/site/templates.scala

+14-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ import com.vladsch.flexmark.util.options.{DataHolder, MutableDataSet}
1616
import com.vladsch.flexmark.html.HtmlRenderer
1717
import com.vladsch.flexmark.formatter.Formatter
1818
import liqp.Template
19+
import liqp.TemplateContext
20+
import liqp.tags.Tag
21+
import liqp.nodes.LNode
1922
import scala.collection.JavaConverters._
2023

2124
import scala.io.Source
@@ -101,7 +104,17 @@ case class TemplateFile(
101104

102105
// Library requires mutable maps..
103106
val mutableProperties = new JHashMap(ctx.properties.transform((_, v) => asJavaElement(v)).asJava)
104-
val rendered = Template.parse(this.rawCode).render(mutableProperties)
107+
108+
// Register escaping {% link ... %} in markdown
109+
val tag = new Tag("link"):
110+
override def render(context: TemplateContext, nodes: Array[? <: LNode]): Object =
111+
val link = super.asString(nodes(0).render(context))
112+
s"{% link $link %}"
113+
114+
val rendered = ssctx.args.projectFormat match
115+
case "html" => Template.parse(this.rawCode).`with`(tag).render(mutableProperties)
116+
case "md" => this.rawCode
117+
105118
// We want to render markdown only if next template is html
106119
val code = if (isHtml || layoutTemplate.exists(!_.isHtml)) rendered else
107120
// Snippet compiler currently supports markdown only

0 commit comments

Comments
 (0)