0.4.0

Author: jonathantneal

lib/Section.js Documentation.jslib/Section.js renamed to Documentation.js

@@ -1,18 +1,18 @@
 var marked = require('marked');
 
-var docHeaderRegex     = /^\s*-{3,}\n([\W\w]+?)\n\s*-{3,}/;
-var docHeaderLineRegex = /([A-z][\w-]*)\s*:\s*([^\n]+)/g;
+var headerRegex     = /^\s*-{3,}\n([\W\w]+?)\n\s*-{3,}/;
+var headerLineRegex = /([A-z][\w-]*)\s*:\s*([^\n]+)/g;
 
 function titleToName(string) {
 	return string.replace(/\s+/g, '_').replace(/[^A-z0-9_]/g, '').toLowerCase();
 }
 
-function Section(node) {
+function Documentation(node) {
 	var self = this;
 
 	if (node.type === 'comment') {
-		self.content  = marked(node.text.replace(docHeaderRegex, function (headerMatch, lines) {
-			lines.replace(docHeaderLineRegex, function (headerLineMatch, name, value) {
+		self.content  = marked(node.text.replace(headerRegex, function (headerMatch, lines) {
+			lines.replace(headerLineRegex, function (headerLineMatch, name, value) {
 				self[name] = value.trim();
 			});
 
@@ -29,8 +29,8 @@ function Section(node) {
 		var hash = {};
 
 		node.walkComments(function (comment) {
-			if (docHeaderRegex.test(comment.text)) {
-				var section = new Section(comment);
+			if (headerRegex.test(comment.text)) {
+				var section = new Documentation(comment);
 
 				hash[section.title] = section;
 			}
@@ -47,7 +47,7 @@ function Section(node) {
 				var parent = hash[title];
 
 				if (!parent) {
-					parent = hash[title] = new Section(section.css.clone({ text: '' }));
+					parent = hash[title] = new Documentation(section.css.clone({ text: '' }));
 
 					parent.title  = title;
 					parent.name   = titleToName(title);
@@ -61,4 +61,4 @@ function Section(node) {
 	}
 }
 
-module.exports = Section;
+module.exports = Documentation;

README.md

@@ -108,6 +108,22 @@ grunt.initConfig({
 });
 ```
 
+## Options
+
+#### `theme`
+
+Type: `NPM Repository`  
+Default: `require('mdcss-theme-github')`
+
+The mdcss theme that you would like to use.
+
+#### `destination`
+
+Type: `String`  
+Default: `'styleguide'`
+
+The directory that you would like your style guide written to.
+
 [ci]:      https://travis-ci.org/jonathantneal/mdcss
 [ci-img]:  https://img.shields.io/travis/jonathantneal/mdcss.svg
 [npm]:     https://www.npmjs.com/package/mdcss

index.js

@@ -1,17 +1,17 @@
-var Section = require('./lib/Section.js');
+var Documentation = require('./Documentation.js');
 
 module.exports = require('postcss').plugin('mdcss', function (opts) {
 	opts = opts || {};
 
-	opts.theme     = opts.theme     || require('mdcss-theme-github');
-	opts.directory = opts.directory || 'styleguide';
-	opts.template  = opts.template  || 'template.ejs';
-	opts.index     = opts.index     || 'index.html';
+	opts.theme       = opts.theme || require('mdcss-theme-github');
+	opts.destination = process.cwd() + '/' + (opts.destination || 'styleguide');
 
 	return function (css, result) {
-		var section = new Section(css);
+		var documentation = new Documentation(css);
 
-		if (typeof opts.theme === 'function') opts.theme(section, opts, result);
+		if (typeof opts.theme === 'function') opts.theme = opts.theme();
+
+		if (typeof opts.theme === 'object' && typeof opts.theme.process === 'function') return opts.theme.process(documentation, opts.destination, result);
 		else result.warn('The theme failed to load.');
 	};
 });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdcss",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Easily create and maintain style guides with CSS comments using Markdown",
   "keywords": [
     "postcss",

test/index.js

@@ -3,8 +3,8 @@ var tests = {
 		'basic': {
 			message: 'supports basic usage',
 			options: {
-				theme:     require('mdcss-theme-github'),
-				directory: 'test/styleguide'
+				theme:       require('mdcss-theme-github'),
+				destination: 'test/styleguide'
 			}
 		}
 	}