diff --git a/README.md b/README.md
index 853f3bc..a31bd6f 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,8 @@
------
-Showdown is a Javascript Markdown to HTML converter, based on the original works by John Gruber. Showdown can be used client side (in the browser) or server side (with NodeJs).
+Showdown is a Javascript Markdown to HTML converter, based on the original works by John Gruber.
+Showdown can be used client side (in the browser) or server side (with NodeJs).
## Live DEMO
@@ -28,7 +29,8 @@ Check a live Demo here http://showdownjs.github.io/demo/
## Donate [](https://www.paypal.me/tiviesantos)
-We're currently looking to improve showdown with automated tests in all browsers and a proper domain and webpage. [If you like our work, please donate!!](https://www.paypal.me/tiviesantos) Your contribution will be greatly appreciated.
+We're currently looking to improve showdown with automated tests in all browsers and a proper domain and webpage.
+[If you like our work, please donate!!](https://www.paypal.me/tiviesantos) Your contribution will be greatly appreciated.
## Installation
@@ -75,7 +77,8 @@ Showdown has been tested successfully with:
* Netscape 8.1.2
* Konqueror 3.5.4
-In theory, Showdown will work in any browser that supports ECMA 262 3rd Edition (JavaScript 1.5). The converter itself might even work in things that aren't web browsers, like Acrobat. No promises.
+In theory, Showdown will work in any browser that supports ECMA 262 3rd Edition (JavaScript 1.5).
+The converter itself might even work in things that aren't web browsers, like Acrobat. No promises.
## Node compatibility
@@ -196,7 +199,8 @@ var defaultOptions = showdown.getDefaultOptions();
var foo = 'bar';
foo
```
- * **simplifiedAutoLink**: (boolean) [default false] Turning this option on will enable automatic linking to urls. This means that
+ * **simplifiedAutoLink**: (boolean) [default false] Turning this option on will enable automatic linking to urls.
+ This means that:
```md
some text www.google.com
@@ -302,12 +314,15 @@ var defaultOptions = showdown.getDefaultOptions();
```
* **smoothLivePreview**: (boolean) [default false] Prevents weird effects in live previews due to incomplete input
- * **smartIndentationFix**: (boolean) [default false] Tries to smartly fix indentation problems related to es6 template strings in the midst of indented code.
+ * **smartIndentationFix**: (boolean) [default false] Tries to smartly fix indentation problems related to es6 template
+ strings in the midst of indented code.
- * **disableForced4SpacesIndentedSublists**: (boolean) [default false] Disables the requirement of indenting sublists by 4 spaces for them to be nested,
- effectively reverting to the old behavior where 2 or 3 spaces were enough. **(since v1.5.0)**
+ * **disableForced4SpacesIndentedSublists**: (boolean) [default false] Disables the requirement of indenting sublists
+ by 4 spaces for them to be nested, effectively reverting to the old behavior where 2 or 3 spaces were enough.
+ **(since v1.5.0)**
- * **simpleLineBreaks**: (boolean) [default false] Parses line breaks as
like GitHub does, without needing 2 spaces at the end of the line **(since v1.5.1)**
+ * **simpleLineBreaks**: (boolean) [default false] Parses line breaks as
like GitHub does, without
+ needing 2 spaces at the end of the line **(since v1.5.1)**
```md
a line
@@ -325,14 +340,16 @@ var defaultOptions = showdown.getDefaultOptions();
* **ghMentions**: (boolean) [default false] Enables github @mentions, which link to the username mentioned **(since v1.6.0)**
- * **ghMentionsLink**: (string) [default `https://github.com/{u}`] Changes the link generated by @mentions. Showdown will replace `{u}` with the username. Only applies if ghMentions option is enabled.
+ * **ghMentionsLink**: (string) [default `https://github.com/{u}`] Changes the link generated by @mentions.
+ Showdown will replace `{u}` with the username. Only applies if ghMentions option is enabled.
Example: `@tivie` with ghMentionsOption set to `//mysite.com/{u}/profile` will result in `@tivie`
* **encodeEmails**: (boolean) [default true] Enables e-mail addresses encoding through the use of Character Entities, transforming ASCII e-mail addresses into its equivalent decimal entities. (since v1.6.1)
NOTE: Prior to version 1.6.1, emails would always be obfuscated through dec and hex encoding.
- * **openLinksInNewWindow**: (boolean) [default false] Open all links in new windows (by adding the attribute `target="_blank"` to `` tags) **(since v1.7.0)**
+ * **openLinksInNewWindow**: (boolean) [default false] Open all links in new windows
+ (by adding the attribute `target="_blank"` to `` tags) **(since v1.7.0)**
* **backslashEscapesHTMLTags**: (boolean) [default false] Support for HTML Tag escaping. ex: `\foo\
` **(since v1.7.2)**
@@ -409,7 +426,8 @@ var showdown = require('showdown'),
## Tests
-A suite of tests is available which require node.js. Once node is installed, run the following command from the project root to install the dependencies:
+A suite of tests is available which require node.js. Once node is installed, run the following command from
+the project root to install the dependencies:
npm install
@@ -417,7 +435,8 @@ Once installed the tests can be run from the project root using:
npm test
-New test cases can easily be added. Create a markdown file (ending in `.md`) which contains the markdown to test. Create a `.html` file of the exact same name. It will automatically be tested when the tests are executed with `mocha`.
+New test cases can easily be added. Create a markdown file (ending in `.md`) which contains the markdown to test.
+Create a `.html` file of the exact same name. It will automatically be tested when the tests are executed with `mocha`.
## Contributing
diff --git a/dist/showdown.js b/dist/showdown.js
index b4540ac..8997436 100644
Binary files a/dist/showdown.js and b/dist/showdown.js differ
diff --git a/dist/showdown.js.map b/dist/showdown.js.map
index 6bfca7f..ddec481 100644
Binary files a/dist/showdown.js.map and b/dist/showdown.js.map differ
diff --git a/dist/showdown.min.js b/dist/showdown.min.js
index a701b58..0ecbf4c 100644
Binary files a/dist/showdown.min.js and b/dist/showdown.min.js differ
diff --git a/dist/showdown.min.js.map b/dist/showdown.min.js.map
index 318a8bf..1bf38e7 100644
Binary files a/dist/showdown.min.js.map and b/dist/showdown.min.js.map differ
diff --git a/src/options.js b/src/options.js
index 2e8f81b..9f5ab93 100644
--- a/src/options.js
+++ b/src/options.js
@@ -18,9 +18,14 @@ function getDefaultOpts (simple) {
},
prefixHeaderId: {
defaultValue: false,
- describe: 'Specify a prefix to generated header ids',
+ describe: 'Add a prefix to the generated header ids. Passing a string will prefix that string to the header id. Setting to true will add a generic \'section-\' prefix',
type: 'string'
},
+ rawPrefixHeaderId: {
+ defaultValue: false,
+ describe: 'Setting this option to true will prevent showdown from modifying the prefix. This might result in malformed IDs (if, for instance, the " char is used in the prefix)',
+ type: 'boolean'
+ },
ghCompatibleHeaderId: {
defaultValue: false,
describe: 'Generate header ids compatible with github style (spaces are replaced with dashes, a bunch of non alphanumeric chars are removed)',
diff --git a/src/subParsers/headers.js b/src/subParsers/headers.js
index 3d3e003..2d0e8a3 100644
--- a/src/subParsers/headers.js
+++ b/src/subParsers/headers.js
@@ -56,7 +56,8 @@ showdown.subParser('headers', function (text, options, globals) {
});
function headerId (m) {
- var title;
+ var title,
+ prefix;
// It is separate from other options to allow combining prefix and customized
if (options.customizedHeaderId) {
@@ -66,13 +67,19 @@ showdown.subParser('headers', function (text, options, globals) {
}
}
+ title = m;
+
// Prefix id to prevent causing inadvertent pre-existing style matches.
if (showdown.helper.isString(options.prefixHeaderId)) {
- title = options.prefixHeaderId + m;
+ prefix = options.prefixHeaderId;
} else if (options.prefixHeaderId === true) {
- title = 'section ' + m;
+ prefix = 'section-';
} else {
- title = m;
+ prefix = '';
+ }
+
+ if (!options.rawPrefixHeaderId) {
+ title = prefix + title;
}
if (options.ghCompatibleHeaderId) {
@@ -102,6 +109,10 @@ showdown.subParser('headers', function (text, options, globals) {
.toLowerCase();
}
+ if (options.rawPrefixHeaderId) {
+ title = prefix + title;
+ }
+
if (globals.hashLinkCounts[title]) {
title = title + '-' + (globals.hashLinkCounts[title]++);
} else {
diff --git a/test/features/rawPrefixHeaderId/simple-with-prefixHeaderId.html b/test/features/rawPrefixHeaderId/simple-with-prefixHeaderId.html
new file mode 100644
index 0000000..d04a026
--- /dev/null
+++ b/test/features/rawPrefixHeaderId/simple-with-prefixHeaderId.html
@@ -0,0 +1 @@
+
diff --git a/test/features/rawPrefixHeaderId/simple-with-prefixHeaderId.md b/test/features/rawPrefixHeaderId/simple-with-prefixHeaderId.md
new file mode 100644
index 0000000..93b3ff3
--- /dev/null
+++ b/test/features/rawPrefixHeaderId/simple-with-prefixHeaderId.md
@@ -0,0 +1 @@
+# some header &/) foo
diff --git a/test/node/testsuite.features.js b/test/node/testsuite.features.js
index 32661e2..d7c5f79 100644
--- a/test/node/testsuite.features.js
+++ b/test/node/testsuite.features.js
@@ -9,7 +9,8 @@ var bootstrap = require('../bootstrap.js'),
simplifiedAutoLinkSuite = bootstrap.getTestSuite('test/features/simplifiedAutoLink/'),
openLinksInNewWindowSuite = bootstrap.getTestSuite('test/features/openLinksInNewWindow/'),
disableForced4SpacesIndentedSublistsSuite = bootstrap.getTestSuite('test/features/disableForced4SpacesIndentedSublists/'),
- html5CompatibleHeaderIdSuite = bootstrap.getTestSuite('test/features/rawHeaderId/');
+ rawHeaderIdSuite = bootstrap.getTestSuite('test/features/rawHeaderId/'),
+ rawPrefixHeaderIdSuite = bootstrap.getTestSuite('test/features/rawPrefixHeaderId/');
describe('makeHtml() features testsuite', function () {
'use strict';
@@ -157,7 +158,7 @@ describe('makeHtml() features testsuite', function () {
// test rawHeaderId support
describe('rawHeaderId support', function () {
var converter,
- suite = html5CompatibleHeaderIdSuite;
+ suite = rawHeaderIdSuite;
for (var i = 0; i < suite.length; ++i) {
if (suite[i].name === 'with-prefixHeaderId') {
converter = new showdown.Converter({rawHeaderId: true, prefixHeaderId: '/prefix/'});
@@ -167,4 +168,14 @@ describe('makeHtml() features testsuite', function () {
it(suite[i].name.replace(/-/g, ' '), assertion(suite[i], converter));
}
});
+
+ // test rawPrefixHeaderId support
+ describe('rawPrefixHeaderId support', function () {
+ var converter,
+ suite = rawPrefixHeaderIdSuite;
+ for (var i = 0; i < suite.length; ++i) {
+ converter = new showdown.Converter({rawPrefixHeaderId: true, prefixHeaderId: '/prefix/'});
+ it(suite[i].name.replace(/-/g, ' '), assertion(suite[i], converter));
+ }
+ });
});