Merge pull request #205 from hoijui/linkifyHeaderStyle

Allow to generate lower case header references through the config

config.json.example

@@ -123,6 +123,7 @@
         {
           "connectionString": "change this",
           "container": "change this"
-        }
+        },
+        "linkifyHeaderStyle": "gfm"
     }
 }

lib/config/default.js

@@ -157,5 +157,6 @@ module.exports = {
   allowEmailRegister: true,
   allowGravatar: true,
   allowPDFExport: true,
-  openID: false
+  openID: false,
+  linkifyHeaderStyle: 'keep-case'
 }

lib/web/statusRouter.js

@@ -96,7 +96,8 @@ statusRouter.get('/config', function (req, res) {
     debug: config.debug,
     version: config.fullversion,
     DROPBOX_APP_KEY: config.dropbox.appKey,
-    allowedUploadMimeTypes: config.allowedUploadMimeTypes
+    allowedUploadMimeTypes: config.allowedUploadMimeTypes,
+    linkifyHeaderStyle: config.linkifyHeaderStyle
   }
   res.set({
     'Cache-Control': 'private', // only cache by client

public/js/extra.js

@@ -164,11 +164,11 @@ export function renderTags (view) {
 }
 
 function slugifyWithUTF8 (text) {
-  // remove html tags and trim spaces
+  // remove HTML tags and trim spaces
   let newText = S(text).trim().stripTags().s
-  // replace all spaces in between to dashes
+  // replace space between words with dashes
   newText = newText.replace(/\s+/g, '-')
-  // slugify string to make it valid for attribute
+  // slugify string to make it valid as an attribute
   newText = newText.replace(/([!"#$%&'()*+,./:;<=>?@[\\\]^`{|}~])/g, '')
   return newText
 }
@@ -833,7 +833,11 @@ const linkifyAnchors = (level, containingElement) => {
     if (header.getElementsByClassName('anchor').length === 0) {
       if (typeof header.id === 'undefined' || header.id === '') {
         // to escape characters not allow in css and humanize
-        const id = slugifyWithUTF8(getHeaderContent(header))
+        let id = slugifyWithUTF8(getHeaderContent(header))
+        // to make compatible with GitHub, GitLab, Pandoc and many more
+        if (window.linkifyHeaderStyle !== 'keep-case') {
+          id = id.toLowerCase()
+        }
         header.id = id
       }
       if (!(typeof header.id === 'undefined' || header.id === '')) {

public/js/lib/common/constant.ejs

@@ -5,4 +5,6 @@ window.version = '<%- version %>'
 
 window.allowedUploadMimeTypes = <%- JSON.stringify(allowedUploadMimeTypes) %>
 
+window.linkifyHeaderStyle = <%- JSON.stringify(linkifyHeaderStyle) %>
+
 window.DROPBOX_APP_KEY = '<%- DROPBOX_APP_KEY %>'