summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--lib/config/default.js13
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/config/default.js b/lib/config/default.js
index f5cceac6..a52a8a4f 100644
--- a/lib/config/default.js
+++ b/lib/config/default.js
@@ -158,5 +158,18 @@ module.exports = {
allowGravatar: true,
allowPDFExport: true,
openID: false,
+ // linkifyHeaderStyle - How is a header text converted into a link id.
+ // Header Example: "3.1. Good Morning my Friend! - Do you have 5$?"
+ // * 'keep-case' is the legacy CodiMD value.
+ // Generated id: "31-Good-Morning-my-Friend---Do-you-have-5"
+ // * 'lower-case' is the same like legacy (see above), but converted to lower-case.
+ // Generated id: "#31-good-morning-my-friend---do-you-have-5"
+ // * 'gfm' _GitHub-Flavored Markdown_ style as described here:
+ // https://gist.github.com/asabaylus/3071099#gistcomment-1593627
+ // It works like 'lower-case', but making sure the ID is unique.
+ // This is What GitHub, GitLab and (hopefully) most other tools use.
+ // Generated id: "31-good-morning-my-friend---do-you-have-5"
+ // 2nd appearance: "31-good-morning-my-friend---do-you-have-5-1"
+ // 3rd appearance: "31-good-morning-my-friend---do-you-have-5-2"
linkifyHeaderStyle: 'keep-case'
}