jsdoc-to-markdown
Advanced tools
Comparing version 0.1.0 to 0.1.1
@@ -16,2 +16,3 @@ #!/usr/bin/env node | ||
{ name: "template", alias: "t", type: String }, | ||
{ name: "preset", alias: "p", type: String }, | ||
{ name: "json", alias: "j", type: Boolean }, | ||
@@ -26,13 +27,23 @@ { name: "src", type: Array, defaultOption: true }, | ||
var templatePath = path.resolve(__dirname, "..", "jsdoc-template"), | ||
cmd = util.format("jsdoc -t %s %s", templatePath, argv.src.join(" ")); | ||
var jsdocTemplatePath = path.resolve(__dirname, "..", "jsdoc-template"), | ||
cmd = util.format( | ||
"%s -t %s %s", | ||
path.resolve(__dirname, "..", "node_modules", ".bin", "jsdoc"), | ||
jsdocTemplatePath, | ||
argv.src.join(" ") | ||
); | ||
function render(data){ | ||
var template = argv.template | ||
? mfs.read(argv.template) | ||
: mfs.read(path.resolve(__dirname, "..", "templates", "default.hbs")) | ||
var template = ""; | ||
if (argv.template){ | ||
template = mfs.read(argv.template); | ||
} else if (argv.preset){ | ||
template = mfs.read(path.resolve(__dirname, "..", "templates", argv.preset + ".hbs")); | ||
} else { | ||
template = mfs.read(path.resolve(__dirname, "..", "templates", "default.hbs")); | ||
} | ||
console.log(boil.render(template, data)); | ||
} | ||
cp.exec(cmd, function(err, stdout, stderr){ | ||
cp.exec(cmd, { maxBuffer: 1000 * 1024 }, function(err, stdout, stderr){ | ||
if (err){ | ||
@@ -39,0 +50,0 @@ console.error(err) |
var w = require("wodge"); | ||
module.exports = function(handlebars){ | ||
handlebars.registerHelper("paramList", function(params){ | ||
return w.arrayify(params).map(function(param){ | ||
return param.optional ? "[" + param.name + "]" : param.name; | ||
}).join(", "); | ||
handlebars.registerHelper("instantiate", function(input){ | ||
return input.charAt(0).toLowerCase() + input.slice(1); | ||
}); | ||
}; |
{ | ||
"name": "jsdoc-to-markdown", | ||
"author": "Lloyd Brookes", | ||
"version": "0.1.0", | ||
"version": "0.1.1", | ||
"description": "Render JSdoc documentation as markdown", | ||
@@ -24,2 +24,3 @@ "repository": "https://github.com/75lb/jsdoc-to-markdown", | ||
"console-dope": "^0.3.3", | ||
"jsdoc": "^3.3.0-alpha5", | ||
"more-fs": "^0.3.0", | ||
@@ -26,0 +27,0 @@ "wodge": "^0.8.0" |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
14374
27
226
6
+ Addedjsdoc@^3.3.0-alpha5
+ Added@babel/helper-string-parser@7.24.8(transitive)
+ Added@babel/helper-validator-identifier@7.24.7(transitive)
+ Added@babel/parser@7.25.6(transitive)
+ Added@babel/types@7.25.6(transitive)
+ Added@types/linkify-it@5.0.0(transitive)
+ Added@types/markdown-it@12.2.3(transitive)
+ Added@types/mdurl@2.0.0(transitive)
+ Addedargparse@2.0.1(transitive)
+ Addedbluebird@3.7.2(transitive)
+ Addedcatharsis@0.9.0(transitive)
+ Addedentities@2.1.0(transitive)
+ Addedescape-string-regexp@2.0.0(transitive)
+ Addedgraceful-fs@4.2.11(transitive)
+ Addedjs2xmlparser@4.0.2(transitive)
+ Addedjsdoc@3.6.11(transitive)
+ Addedklaw@3.0.0(transitive)
+ Addedlinkify-it@3.0.3(transitive)
+ Addedlodash@4.17.21(transitive)
+ Addedmarkdown-it@12.3.2(transitive)
+ Addedmarkdown-it-anchor@8.6.7(transitive)
+ Addedmarked@4.3.0(transitive)
+ Addedmdurl@1.0.1(transitive)
+ Addedmkdirp@1.0.4(transitive)
+ Addedrequizzle@0.2.4(transitive)
+ Addedstrip-json-comments@3.1.1(transitive)
+ Addedtaffydb@2.6.2(transitive)
+ Addedto-fast-properties@2.0.0(transitive)
+ Addeduc.micro@1.0.6(transitive)
+ Addedunderscore@1.13.7(transitive)
+ Addedxmlcreate@2.0.4(transitive)