Document dottydoc capabilities, add anchored headers

2 files changed, 12 insertions, 5 deletions

diff --git a/doc-tool/src/dotty/tools/dottydoc/staticsite/BlogPost.scala b/doc-tool/src/dotty/tools/dottydoc/staticsite/BlogPost.scala
index 4683ed5f9..f68157e40 100644
--- a/doc-tool/src/dotty/tools/dottydoc/staticsite/BlogPost.scala
+++ b/doc-tool/src/dotty/tools/dottydoc/staticsite/BlogPost.scala
@@ -9,17 +9,22 @@ import dotc.config.Printers.dottydoc
 
 import MapOperations._
 
+/**
+ *  A `BlogPost` represents the parsed posts from `./blog/_posts/`
+ *  each post must be named according to the format
+ *  `YYYY-MM-DD-title.{md,html}`
+ */
 class BlogPost(
   val title: String,
   val url: String,
   val date: String,
   val content: String,
   firstParagraph: String,
-  val excerptSep: Option[String],
+  val excerpt_separator: Option[String],
   val categories: JList[String]
 ) {
   import scala.collection.JavaConverters._
-  lazy val excerpt: String = excerptSep match {
+  lazy val excerpt: String = excerpt_separator match {
     case Some(str) => content.split(str).head
     case _ => firstParagraph
   }
@@ -29,7 +34,7 @@ class BlogPost(
     "date" -> date,
     "url" -> url,
     "excerpt" -> excerpt,
-    "excerpt_separator" -> excerptSep.getOrElse(""),
+    "excerpt_separator" -> excerpt_separator.getOrElse(""),
     "content" -> content,
     "categories" -> categories
   ).asJava
diff --git a/doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala b/doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala
index ace52725d..895668df2 100644
--- a/doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala
+++ b/doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala
@@ -17,6 +17,7 @@ import com.vladsch.flexmark.ext.gfm.strikethrough.StrikethroughExtension
 import com.vladsch.flexmark.ext.gfm.tasklist.TaskListExtension
 import com.vladsch.flexmark.ext.emoji.EmojiExtension
 import com.vladsch.flexmark.ext.autolink.AutolinkExtension
+import com.vladsch.flexmark.ext.anchorlink.AnchorLinkExtension
 import com.vladsch.flexmark.ext.front.matter.YamlFrontMatterExtension
 import com.vladsch.flexmark.util.options.{ DataHolder, MutableDataSet }
 
@@ -292,10 +293,10 @@ case class Site(val root: JFile, val projectTitle: String, val documentation: Ma
 
     val defaultLayouts: Map[String, String] = Map(
       "main" -> "/_layouts/main.html",
-      "doc" -> "/_layouts/doc.html",
+      "sidebar" -> "/_layouts/sidebar.html",
       "doc-page" -> "/_layouts/doc-page.html",
       "api-page" -> "/_layouts/api-page.html",
-      "blog" -> "/_layouts/blog.html",
+      "blog-page" -> "/_layouts/blog-page.html",
       "index" -> "/_layouts/index.html"
     ).mapValues(getResource)
 
@@ -362,6 +363,7 @@ object Site {
         TablesExtension.create(),
         TaskListExtension.create(),
         AutolinkExtension.create(),
+        AnchorLinkExtension.create(),
         EmojiExtension.create(),
         YamlFrontMatterExtension.create(),
         StrikethroughExtension.create()