我正在使用JS Doc版本3(https://github.com/jsdoc3/jsdoc)。当我运行该工具时,默认情况下它会生成HTML格式的文档。是否可以生成PDF格式的文档?
答案 0 :(得分:7)
我建议你看看jsPDF。它很酷且易于使用。
您从上述方面下载的代码包含范围示例。
什么是jsPDF:用于生成PDF的HTML5客户端解决方案。完美的活动门票,报告,证书,你的名字!
例如,要生成html的pdf,只需编写以下代码。
var doc = new jsPDF();
// We'll make our own renderer to skip this editor
var specialElementHandlers = {
'#editor': function(element, renderer){
return true;
}
};
// All units are in the set measurement for the document
// This can be changed to "pt" (points), "mm" (Default), "cm", "in"
doc.fromHTML($('body').get(0), 15, 15, {
'width': 170,
'elementHandlers': specialElementHandlers
});
这是您下载时获得的示例页面jsPDF的快照。它包含不同的示例类型,代码和pdf生成示例。
答案 1 :(得分:2)
目前没有将jsdoc直接转换为PDF的工具,但您可以将其转换为某种中间格式(本例中为markdown),然后将其转换为PDF:
安装所需的工具
$ npm install -g markdown-pdf
$ npm install -g jsdoc-to-markdown
使用文档生成单个降价文件
$ jsdoc2md path/to/your/code/** > docs.md
将markdown文件转换为PDF:
$ markdown-pdf docs.md
您可以使用css样式表(here you can find an example stylesheet)更改文档的外观。
答案 2 :(得分:0)
你现在有html文件,有很多工具可以将html转换为pdf (我假设你使用node.js)