Skip to content

Instantly share code, notes, and snippets.

@windgazer
Created February 5, 2015 00:06
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save windgazer/d44f486d832afb1cb338 to your computer and use it in GitHub Desktop.
Save windgazer/d44f486d832afb1cb338 to your computer and use it in GitHub Desktop.
Quick n Dirty Github wiki jsdoc using jsdoc-to-markdown
/* global require, module */
/* jshint camelcase: false */
module.exports = function(grunt) {
"use strict";
require("matchdep").filterDev("grunt-*").forEach(grunt.loadNpmTasks);
// Project configuration.
grunt.initConfig({
pkg: grunt.file.readJSON("package.json"),
jsdoc2md: {
withOptions: {
options: {
template: "wiki.hbs",
partial: "partials/*.hbs"
},
src: ["README.md","code/*.js"],
dest: "<%= pkg.wiki.target %>/Home.md"
}
}
});
grunt.registerTask("wiki", ["jsdoc2md"]);
};
{{!-- disable this partial --}}
{{!-- disable this partial --}}
#Yet Another Doc Test
Here I go again, another test-run of the docs...
#TOC
[TOC]
#API Reference
{{>documentation}}
*documented by [jsdoc-to-markdown][1]*
[1]:https://github.com/75lb/jsdoc-to-markdown
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment