Add option to disable anchor for headline in markdown

src/main/scala/gitbucket/core/plugin/Renderer.scala

@@ -20,7 +20,7 @@ trait Renderer {
 object MarkdownRenderer extends Renderer {
   override def render(request: RenderRequest): Html = {
     import request._
-    Html(Markdown.toHtml(fileContent, repository, enableWikiLink, enableRefsLink)(context))
+    Html(Markdown.toHtml(fileContent, repository, enableWikiLink, enableRefsLink, enableAnchor)(context))
   }
 }
 
@@ -41,4 +41,5 @@ case class RenderRequest(filePath: List[String],
    repository: RepositoryService.RepositoryInfo,
    enableWikiLink: Boolean,
    enableRefsLink: Boolean,
+   enableAnchor: Boolean,
    context: Context)

src/main/scala/gitbucket/core/util/Notifier.scala

@@ -75,7 +75,7 @@ class Mailer(private val smtp: Smtp) extends Notifier {
       database withSession { implicit session =>
         defining(
           s"[${r.name}] ${issue.title} (#${issue.issueId})" ->
-            msg(Markdown.toHtml(content, r, false, true))) { case (subject, msg) =>
+            msg(Markdown.toHtml(content, r, false, true, false))) { case (subject, msg) =>
             recipients(issue) { to =>
               val email = new HtmlEmail
               email.setHostName(smtp.host)

src/main/scala/gitbucket/core/view/Markdown.scala

@@ -18,11 +18,20 @@ object Markdown {
 
   /**
    * Converts Markdown of Wiki pages to HTML.
+   *
+   * @param repository the repository which contains the markdown
+   * @param enableWikiLink if true then wiki style link is available in markdown
+   * @param enableRefsLink if true then issue reference (e.g. #123) is rendered as link
+   * @param enableAnchor if true then anchor for headline is generated
+   * @param enableTaskList if true then task list syntax is available
+   * @param hasWritePermission
+   * @param pages the list of existing Wiki pages
    */
   def toHtml(markdown: String,
              repository: RepositoryService.RepositoryInfo,
              enableWikiLink: Boolean,
              enableRefsLink: Boolean,
+             enableAnchor: Boolean,
              enableTaskList: Boolean = false,
              hasWritePermission: Boolean = false,
              pages: List[String] = Nil)(implicit context: Context): String = {
@@ -41,7 +50,7 @@ object Markdown {
       Extensions.AUTOLINKS | Extensions.WIKILINKS | Extensions.FENCED_CODE_BLOCKS | Extensions.TABLES | Extensions.HARDWRAPS | Extensions.SUPPRESS_ALL_HTML
     ).parseMarkdown(source.toCharArray)
 
-    new GitBucketHtmlSerializer(markdown, repository, enableWikiLink, enableRefsLink, enableTaskList, hasWritePermission, pages).toHtml(rootNode)
+    new GitBucketHtmlSerializer(markdown, repository, enableWikiLink, enableRefsLink, enableAnchor, enableTaskList, hasWritePermission, pages).toHtml(rootNode)
   }
 }
 
@@ -101,6 +110,7 @@ class GitBucketHtmlSerializer(
     enableWikiLink: Boolean,
     enableRefsLink: Boolean,
     enableTaskList: Boolean,
+    enableAnchor: Boolean,
     hasWritePermission: Boolean,
     pages: List[String]
   )(implicit val context: Context) extends ToHtmlSerializer(
@@ -152,11 +162,15 @@ class GitBucketHtmlSerializer(
     val tag = s"h${node.getLevel}"
     val headerTextString = printChildrenToString(node)
     val anchorName = GitBucketHtmlSerializer.generateAnchorName(headerTextString)
-    printer.print(s"""<$tag class="markdown-head">""")
-    printer.print(s"""<a class="markdown-anchor-link" href="#$anchorName"></a>""")
-    printer.print(s"""<a class="markdown-anchor" name="$anchorName"></a>""")
+    if(enableAnchor){
+      printer.print(s"""<$tag class="markdown-head">""")
+      printer.print(s"""<a class="markdown-anchor-link" href="#$anchorName"></a>""")
+      printer.print(s"""<a class="markdown-anchor" name="$anchorName"></a>""")
+    }
     visitChildren(node)
-    printer.print(s"</$tag>")
+    if(enableAnchor){
+      printer.print(s"</$tag>")
+    }
   }
 
   override def visit(node: HeaderNode): Unit = {

src/main/scala/gitbucket/core/view/helpers.scala

@@ -91,16 +91,16 @@ object helpers extends AvatarImageProvider with LinkConverter with RequestCache
                enableTaskList: Boolean = false,
                hasWritePermission: Boolean = false,
                pages: List[String] = Nil)(implicit context: Context): Html =
-    Html(Markdown.toHtml(value, repository, enableWikiLink, enableRefsLink, enableTaskList, hasWritePermission, pages))
+    Html(Markdown.toHtml(value, repository, enableWikiLink, enableRefsLink, enableTaskList, true, hasWritePermission, pages))
 
   def renderMarkup(filePath: List[String], fileContent: String, branch: String,
                    repository: RepositoryService.RepositoryInfo,
-                   enableWikiLink: Boolean, enableRefsLink: Boolean)(implicit context: Context): Html = {
+                   enableWikiLink: Boolean, enableRefsLink: Boolean, enableAnchor: Boolean)(implicit context: Context): Html = {
 
     val fileName  = filePath.reverse.head.toLowerCase
     val extension = FileUtil.getExtension(fileName)
     val renderer  = PluginRegistry().getRenderer(extension)
-    renderer.render(RenderRequest(filePath, fileContent, branch, repository, enableWikiLink, enableRefsLink, context))
+    renderer.render(RenderRequest(filePath, fileContent, branch, repository, enableWikiLink, enableRefsLink, enableAnchor, context))
   }
 
   def isRenderable(fileName: String): Boolean = {

src/main/twirl/gitbucket/core/repo/blob.scala.html

@@ -78,7 +78,7 @@
             @defining(isRenderable(pathList.reverse.head)){ isRrenderable =>
               @if(!isBlame && isRrenderable) {
                 <div class="box-content markdown-body" style="border: none; padding-left: 16px; padding-right: 16px;">
-                  @renderMarkup(pathList, content.content.get, branch, repository, false, false)
+                  @renderMarkup(pathList, content.content.get, branch, repository, false, false, true)
                 </div>
               } else {
                 <pre class="prettyprint linenums blob @if(!isRrenderable){ no-renderable } ">@content.content.get</pre>

src/main/twirl/gitbucket/core/repo/files.scala.html

@@ -128,7 +128,7 @@
     @readme.map { case(filePath, content) =>
       <div id="readme">
         <div class="box-header">@filePath.reverse.head</div>
-        <div class="box-content markdown-body">@renderMarkup(filePath, content, branch, repository, false, false)</div>
+        <div class="box-content markdown-body">@renderMarkup(filePath, content, branch, repository, false, false, true)</div>
       </div>
     }
   }