feat(flavours): add markdown presets/flavors

This feature enables users to select a preset/flavor. A flavor is just a preset of options, a shortcut so users don't have to set each option one by one. Closes #164
showdownjs · Jul 12, 2015 · 7e55bce · 7e55bce
1 parent 20ca099
commit 7e55bce
Show file tree

Hide file tree

Showing 7 changed files with 125 additions and 7 deletions.
diff --git a/dist/showdown.js b/dist/showdown.js
diff --git a/dist/showdown.js.map b/dist/showdown.js.map
diff --git a/dist/showdown.min.js b/dist/showdown.min.js
diff --git a/dist/showdown.min.js.map b/dist/showdown.min.js.map
diff --git a/src/converter.js b/src/converter.js
@@ -285,6 +285,21 @@ showdown.Converter = function (converterOptions) {
     _parseExtension(extensionName);
   };
 
+  /**
+   * Set the flavor THIS converter should use
+   * @param {string} name
+   */
+  this.setFlavor = function (name) {
+    if (flavor.hasOwnProperty(name)) {
+      var preset = flavor[name];
+      for (var option in preset) {
+        if (preset.hasOwnProperty(option)) {
+          options[option] = preset[option];
+        }
+      }
+    }
+  };
+
   /**
    * Remove an extension from THIS converter.
    * Note: This is a costly operation. It's better to initialize a new converter

diff --git a/src/showdown.js b/src/showdown.js
@@ -20,7 +20,21 @@ var showdown = {},
       ghCodeBlocks:              true,  // true due to historical reasons
       tasklists:                 false
     },
-    globalOptions = JSON.parse(JSON.stringify(defaultOptions)); //clone default options out of laziness =P
+    globalOptions = JSON.parse(JSON.stringify(defaultOptions)),
+    flavor = {
+      github: {
+        omitExtraWLInCodeBlocks:   true,
+        prefixHeaderId:            'user-content-',
+        simplifiedAutoLink:        true,
+        literalMidWordUnderscores: true,
+        strikethrough:             true,
+        tables:                    true,
+        tablesHeaderId:            true,
+        ghCodeBlocks:              true,
+        tasklists:                 true
+      },
+      vanilla: JSON.parse(JSON.stringify(defaultOptions))
+    };
 
 /**
  * helper namespace
@@ -77,6 +91,22 @@ showdown.resetOptions = function () {
   globalOptions = JSON.parse(JSON.stringify(defaultOptions));
 };
 
+/**
+ * Set the flavor showdown should use as default
+ * @param {string} name
+ */
+showdown.setFlavor = function (name) {
+  'use strict';
+  if (flavor.hasOwnProperty(name)) {
+    var preset = flavor[name];
+    for (var option in preset) {
+      if (preset.hasOwnProperty(option)) {
+        globalOptions[option] = preset[option];
+      }
+    }
+  }
+};
+
 /**
  * Get the default options
  * @static

diff --git a/test/node/showdown.Converter.js b/test/node/showdown.Converter.js
@@ -27,6 +27,34 @@ describe('showdown.Converter', function () {
     });
   });
 
+  describe('setFlavor() github', function () {
+    var converter = new showdown.Converter(),
+        ghOpts = {
+          omitExtraWLInCodeBlocks:   true,
+          prefixHeaderId:            'user-content-',
+          simplifiedAutoLink:        true,
+          literalMidWordUnderscores: true,
+          strikethrough:             true,
+          tables:                    true,
+          tablesHeaderId:            true,
+          ghCodeBlocks:              true,
+          tasklists:                 true
+        };
+
+    converter.setFlavor('github');
+
+    for (var opt in ghOpts) {
+      if (ghOpts.hasOwnProperty(opt)) {
+        check(opt, ghOpts[opt]);
+      }
+    }
+    function check(key, val) {
+      it('should set ' + opt + ' to ' + val, function () {
+        converter.getOption(key).should.equal(val);
+      });
+    }
+  });
+
   describe('extension methods', function () {
     var extObjMock = {
           type: 'lang',