status-im
/
codimd
mirror of https://github.com/status-im/codimd.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Allow to generate lower case header references through the config (#1305) 

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>
This commit is contained in:
hoijui 2019-10-21 22:10:06 +02:00
parent 9e4d07926a
commit 34c2bfcfc5
5 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
config.json.example
View File

@ -127,6 +127,7 @@
"plantuml": "plantuml":
{ {
"server": "https://www.plantuml.com/plantuml" "server": "https://www.plantuml.com/plantuml"
} },
"linkifyHeaderStyle": "gfm"
} }
} }

3
lib/config/default.js
View File

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

3
lib/web/statusRouter.js
View File

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

6
public/js/extra.js
View File

@ -867,7 +867,11 @@ const linkifyAnchors = (level, containingElement) => {
if (header.getElementsByClassName('anchor').length === 0) { if (header.getElementsByClassName('anchor').length === 0) {
if (typeof header.id === 'undefined' || header.id === '') { if (typeof header.id === 'undefined' || header.id === '') {
// to escape characters not allow in css and humanize // to escape characters not allow in css and humanize
const id = slugifyWithUTF8(getHeaderContent(header)) var 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 header.id = id
} }
if (!(typeof header.id === 'undefined' || header.id === '')) { if (!(typeof header.id === 'undefined' || header.id === '')) {

2
public/js/lib/common/constant.ejs
View File

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