2016-10-11 2 views
8

Я использую JS Doc версии 3 (https://github.com/jsdoc3/jsdoc). Когда я запускаю инструмент, по умолчанию он создает документацию в формате HTML. Возможно ли создать документ в формате PDF?Может ли JS Doc генерировать PDF

+2

После того, как ваш HTML-код запускается через [http://wkhtmltopdf.org/](http://wkhtmltopdf.org/) –

+0

Это решение, предложенное http://stackoverflow.com/questions/4014280/ jsdoc-to-pdf-renderer – krampstudio

+0

Нет, не по-своему. Как и @ZoltanToth, используйте wkhtmltopdf. –

ответ

7

Я хотел бы предложить вы смотрите на jsPDF. Это довольно круто и легко использовать.

Код, указанный на указанной странице, содержит примеры использования.

Что такое jsPDF: клиентское решение HTML5 для создания PDF-файлов. Идеально подходит для билетов на мероприятия, отчетов, сертификатов, вы называете это!

Например, чтобы создать pdf-файл html, просто напишите следующий код.

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.

enter image description here

2

В настоящее время не существует инструмент для преобразования JSDoc непосредственно в PDF, но вы можете преобразовать его в какой-то промежуточный формат (уценки в этом примере), а затем преобразовать его в PDF:

  1. Установите необходимые инструменты

    $ npm install -g markdown-pdf 
    $ npm install -g jsdoc-to-markdown 
    
  2. Сформировать единый файл уценки с документацией

    $ jsdoc2md path/to/your/code/** > docs.md 
    
  3. Преобразовать уценки файл в формате PDF:

    $ markdown-pdf docs.md 
    

Вы можете изменить как документация выглядит с помощью CSS стилей (here you can find an example stylesheet).

Смежные вопросы