Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

project setup

  • Loading branch information...
commit afb922c030ff1c55a86c9283652bf13ce01abad0 0 parents
@treasonx authored
1  .npmignore
@@ -0,0 +1 @@
+/node_modules/
22 LICENSE-MIT
@@ -0,0 +1,22 @@
+Copyright (c) 2012 James Morrin
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
28 README.md
@@ -0,0 +1,28 @@
+# grunt-markdown
+
+Compile markdown to html
+
+## Getting Started
+Install this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-markdown`
+
+Then add this line to your project's `grunt.js` gruntfile:
+
+```javascript
+grunt.loadNpmTasks('grunt-markdown');
+```
+
+[grunt]: http://gruntjs.com/
+[getting_started]: https://github.com/gruntjs/grunt/blob/master/docs/getting_started.md
+
+## Documentation
+_(Coming soon)_
+
+## Contributing
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt][grunt].
+
+## Release History
+_(Nothing yet)_
+
+## License
+Copyright (c) 2012 James Morrin
+Licensed under the MIT license.
2  bin/grunt-markdown
@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('grunt').npmTasks('grunt-markdown').cli();
40 grunt.js
@@ -0,0 +1,40 @@
+module.exports = function(grunt) {
+
+ // Project configuration.
+ grunt.initConfig({
+ test: {
+ files: ['test/**/*.js']
+ },
+ lint: {
+ files: ['grunt.js', 'tasks/**/*.js', 'test/**/*.js']
+ },
+ watch: {
+ files: '<config:lint.files>',
+ tasks: 'default'
+ },
+ jshint: {
+ options: {
+ curly: true,
+ eqeqeq: true,
+ immed: true,
+ latedef: true,
+ newcap: true,
+ noarg: true,
+ sub: true,
+ undef: true,
+ boss: true,
+ eqnull: true,
+ node: true,
+ es5: true
+ },
+ globals: {}
+ }
+ });
+
+ // Load local tasks.
+ grunt.loadTasks('tasks');
+
+ // Default task.
+ grunt.registerTask('default', 'lint test');
+
+};
37 package.json
@@ -0,0 +1,37 @@
+{
+ "name": "grunt-markdown",
+ "description": "Compile markdown to html",
+ "version": "0.1.0",
+ "homepage": "https://github.com/treasonx/grunt-markdown",
+ "author": {
+ "name": "James Morrin",
+ "email": "treasonx@gmail.com"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git://github.com/treasonx/grunt-markdown"
+ },
+ "bugs": {
+ "url": "https://github.com/treasonx/grunt-markdown/issues"
+ },
+ "licenses": [
+ {
+ "type": "MIT",
+ "url": "https://github.com/treasonx/grunt-markdown/blob/master/LICENSE-MIT"
+ }
+ ],
+ "main": "grunt.js",
+ "bin": "bin/grunt-markdown",
+ "engines": {
+ "node": "*"
+ },
+ "scripts": {
+ "test": "grunt test"
+ },
+ "devDependencies": {
+ "grunt": "~0.3.16"
+ },
+ "keywords": [
+ "gruntplugin"
+ ]
+}
60 tasks/markdown.js
@@ -0,0 +1,60 @@
+/*
+ * grunt-markdown
+ * https://github.com/treasonx/grunt-markdown
+ *
+ * Copyright (c) 2012 James Morrin
+ * Licensed under the MIT license.
+ */
+
+module.exports = function(grunt) {
+
+ var path = require('path');
+ var markdown = require('markdown');
+ var hljs = require('highlight.js');
+
+ grunt.registerHelper('markdown', function(src, options) {
+
+ options.highlight = options.highlight || 'manual';
+
+ if(typeof options.highlight === 'string') {
+ if(options.highlight === 'auto') {
+ options.highlight = function(code) {
+ return hljs.highlightAuto(code).value;
+ };
+ } else if (options.highlight === 'manual') {
+ options.highlight = function(code, lang) {
+ return hljs.highlight(lang, code).value;
+ };
+ }
+
+ }
+
+ if(typeof options === 'object') {
+ markdown.setOptions(options);
+ }
+
+ grunt.verbose.write('Marking down...');
+
+ return markdown(src);
+
+ });
+
+ grunt.registerMultiTask('markdown', 'compiles markdown files into html', function() {
+
+ var options = grunt.config(['jshint', this.target, 'options']);
+ var destPath = this.dest.path;
+ var extension = this.data.extenstion || 'html';
+
+ grunt.file.expandFiles(this.file.src).forEach(function(filepath) {
+
+ var html = grunt.helper('markdown', grunt.file.read(filepath), options);
+ var ext = path.extname(filepath);
+ var dest = path.join(destPath, path.basename(filepath, ext) + extension);
+ grunt.file.write(dest, html);
+
+ });
+
+ });
+
+};
+
34 test/markdown_test.js
@@ -0,0 +1,34 @@
+var grunt = require('grunt');
+
+/*
+ ======== A Handy Little Nodeunit Reference ========
+ https://github.com/caolan/nodeunit
+
+ Test methods:
+ test.expect(numAssertions)
+ test.done()
+ Test assertions:
+ test.ok(value, [message])
+ test.equal(actual, expected, [message])
+ test.notEqual(actual, expected, [message])
+ test.deepEqual(actual, expected, [message])
+ test.notDeepEqual(actual, expected, [message])
+ test.strictEqual(actual, expected, [message])
+ test.notStrictEqual(actual, expected, [message])
+ test.throws(block, [error], [message])
+ test.doesNotThrow(block, [error], [message])
+ test.ifError(value)
+*/
+
+exports['markdown'] = {
+ setUp: function(done) {
+ // setup here
+ done();
+ },
+ 'helper': function(test) {
+ test.expect(1);
+ // tests here
+ test.equal(grunt.helper('markdown'), 'markdown!!!', 'should return the correct value.');
+ test.done();
+ }
+};
Please sign in to comment.
Something went wrong with that request. Please try again.