Skip to content
Permalink
Browse files

Allow to generate lower case header references through the config

This makes the references consistent/compatible with GitHub,
GitLab, Pandoc and many other tools.

This behavior can be enabled in config.json with:

```
"linkifyHeaderStyle": "gfm"
```

Signed-off-by: hoijui <hoijui.quaero@gmail.com>
  • Loading branch information...
hoijui committed Oct 21, 2019
1 parent 20adab2 commit e654ca8a3130108a6616131e35524d8f50d80ed0
Showing with 13 additions and 4 deletions.
  1. +2 −1 config.json.example
  2. +2 −1 lib/config/default.js
  3. +2 −1 lib/web/statusRouter.js
  4. +5 −1 public/js/extra.js
  5. +2 −0 public/js/lib/common/constant.ejs
@@ -123,6 +123,7 @@
{
"connectionString": "change this",
"container": "change this"
}
},
"linkifyHeaderStyle": "gfm"
}
}
@@ -157,5 +157,6 @@ module.exports = {
allowEmailRegister: true,
allowGravatar: true,
allowPDFExport: true,
openID: false
openID: false,
linkifyHeaderStyle: 'keep-case'
}
@@ -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
@@ -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 === '')) {
@@ -5,4 +5,6 @@ window.version = '<%- version %>'

window.allowedUploadMimeTypes = <%- JSON.stringify(allowedUploadMimeTypes) %>

window.linkifyHeaderStyle = <%- JSON.stringify(linkifyHeaderStyle) %>

window.DROPBOX_APP_KEY = '<%- DROPBOX_APP_KEY %>'

0 comments on commit e654ca8

Please sign in to comment.
You can’t perform that action at this time.