its-treason / md-files-to-pdf

md-files-to-pdf

Generate a PDF from multiple MarkDown files.

Usage

import {pdfFromMdFiles} from 'md-files-to-pdf';

const options = {
  heading: 'Example',
};

pdfFromMdFiles('path/to/md-files', 'path/to/pdf', options);

Options

{
  heading?: string, // Heading at the top. Default: Folder-Name
  outputHtml?: string, // Path to save the generated HTML file, helpful for debugging
  generateToc?: boolean, // If true, Generate a Table of Contents at the Top of the File
}

CLI-Usage Options

--doc-path "path/to/md-files" // Requiered, Path to Folder with MarkDown files
--out-path "path/to/pdf" // Requiered, Path where the PDF should me saved
--heading "Example" // Optional, Heading at the top. Default: Folder-Name
--output-html "path/to/html" // Optional, save the generated HTML file, helpful for debugging
--generate-toc // Optional, Generate a Table of Contents at the Top of the File

Development

npm run start -- --doc-path ./example_docs --out-path out.pdf --heading Doc-Test

Thanks

Thanks to Simon Hänisch and Contributors for creating md-to-pdf where i looked up some code.

md-files-to-pdf's Issues

Font-Sizes in Documents are all over the place

Font-Sizes are different in Tables, Codeblocks and Heading font-sizes are also weird.

Add Support for Localy saved images

Images wich are localy saved and used in Markdown files should also be able to be rendered in the PDF.

The render Process then needs to start a WebServer having the rendered HTML and all the images in is Webroot.

Add Quiet Option

Add option in to disable the output of Warnings and info messages

Add Option to output the full HTML file

Add a Option to save the generated HTML file.

Add Option to generate Table of Contents

Add a option to generate a Table of contents after the H1 Heading. Table of Contents items should be a Link