Prototype of markdown preprocessing of static sites

Author: BarkingBad

docs/docs/reference/other-new-features/opaques.md

@@ -1,6 +1,6 @@
 ---
-layout: doc-page
 title: "Opaque Type Aliases"
+hasFrame: false
 ---
 
 Opaque types aliases provide type abstraction without any overhead. Example:

docs/index.html

@@ -1,7 +1,6 @@
 ---
 title: Scala 3
 layout: main
-hasFrame: false
 extraCSS:
     - css/frontpage.css
 ---

scaladoc/src/dotty/tools/scaladoc/renderers/HtmlRenderer.scala

@@ -101,13 +101,7 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
 
   def renderPage(page: Page, parents: Vector[Link]): Seq[String] =
     val newParents = parents :+ page.link
-    val content = html(
-      mkHead(page),
-      body(
-        if !page.hasFrame then renderContent(page)
-        else mkFrame(page.link, newParents, renderContent(page))
-      )
-    )
+    val content = renderContent(page)
     write(page.link.dri, content) +: page.children.flatMap(renderPage(_, newParents))
 
   private def specificResources(page: Page): Set[String] =

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

@@ -14,6 +14,7 @@ import com.vladsch.flexmark.ext.yaml.front.matter.{AbstractYamlFrontMatterVisito
 import com.vladsch.flexmark.parser.{Parser, ParserEmulationProfile}
 import com.vladsch.flexmark.util.options.{DataHolder, MutableDataSet}
 import com.vladsch.flexmark.ext.wikilink.WikiLinkExtension
+import com.vladsch.flexmark.formatter.Formatter
 
 import scala.collection.JavaConverters._
 
@@ -36,7 +37,7 @@ val defaultMarkdownOptions: DataHolder =
       YamlFrontMatterExtension.create(),
       StrikethroughExtension.create(),
       WikiLinkExtension.create(),
-      tasty.comments.markdown.SnippetRenderingExtension
+      tasty.comments.markdown.SnippetFormattingExtension,
     ))
 
 def emptyTemplate(file: File, title: String): TemplateFile = TemplateFile(

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

@@ -14,6 +14,7 @@ import com.vladsch.flexmark.ext.yaml.front.matter.{AbstractYamlFrontMatterVisito
 import com.vladsch.flexmark.parser.{Parser, ParserEmulationProfile}
 import com.vladsch.flexmark.util.options.{DataHolder, MutableDataSet}
 import com.vladsch.flexmark.html.HtmlRenderer
+import com.vladsch.flexmark.formatter.Formatter
 import liqp.Template
 import scala.collection.JavaConverters._
 
@@ -107,7 +108,10 @@ case class TemplateFile(
       val parser: Parser = Parser.builder(defaultMarkdownOptions).build()
       val parsedMd = parser.parse(rendered)
       val processed = FlexmarkSnippetProcessor.processSnippets(parsedMd, ssctx.snippetCompilerArgs.debug, snippetCheckingFunc)(using ssctx.outerCtx)
-      HtmlRenderer.builder(defaultMarkdownOptions).build().render(processed)
+
+      Formatter.builder(defaultMarkdownOptions).build().render(processed)
+
+      // HtmlRenderer.builder(defaultMarkdownOptions).build().render(processed)
 
     layoutTemplate match
       case None => ResolvedPage(code, resources ++ ctx.resources)

scaladoc/src/dotty/tools/scaladoc/tasty/comments/markdown/SnippetFormattingExtension.scala

@@ -0,0 +1,40 @@
+package dotty.tools.scaladoc
+package tasty.comments.markdown
+
+import dotty.tools.scaladoc.snippets._
+
+import com.vladsch.flexmark.formatter._
+import com.vladsch.flexmark.parser._
+import com.vladsch.flexmark.ext.wikilink._
+import com.vladsch.flexmark.ext.wikilink.internal.WikiLinkLinkRefProcessor
+import com.vladsch.flexmark.util.ast._
+import com.vladsch.flexmark.util.options._
+import com.vladsch.flexmark.util.sequence.BasedSequence
+import com.vladsch.flexmark._
+
+object SnippetFormattingExtension extends Formatter.FormatterExtension:
+
+  def rendererOptions(opt: MutableDataHolder): Unit = ()
+
+  object ExtendedFencedCodeBlockHandler extends CustomNodeFormatter[ExtendedFencedCodeBlock]:
+    override def render(node: ExtendedFencedCodeBlock, c: NodeFormatterContext, markdown: MarkdownWriter): Unit =
+      markdown.append(
+        SnippetRenderer.renderSnippetWithMessages(
+          node.codeBlock.getContentChars.toString.split("\n").map(_ + "\n").toSeq,
+          node.compilationResult.toSeq.flatMap(_.messages)
+        )
+      )
+
+  object Format extends NodeFormatter:
+    override def getNodeFormattingHandlers: JSet[NodeFormattingHandler[?]] =
+      JSet(
+        new NodeFormattingHandler(classOf[ExtendedFencedCodeBlock], ExtendedFencedCodeBlockHandler),
+      )
+
+    def getNodeClasses: JSet[Class[?]] = null
+
+  object Factory extends NodeFormatterFactory:
+    override def create(options: DataHolder): NodeFormatter = Format
+
+  def extend(formatterBuilder: Formatter.Builder) =
+    formatterBuilder.nodeFormatterFactory(Factory)