Introduction to mdpdf

mdpdf is a powerful utility that allows developers to transform Markdown files into beautifully formatted PDFs. This tool simplifies the process of converting Markdown documents into PDF format with ease, ensuring that the output is professional and visually pleasing. mdpdf comes with a comprehensive API, enabling a broad range of customizations and functionalities.

Getting Started with mdpdf

To get started, you can install mdpdf using npm:

npm install -g mdpdf

Basic Conversion

Here’s a basic example of converting a Markdown file to a PDF:

mdpdf input.md -o output.pdf

API Examples

Customizing Styles

You can customize the styles of your PDF using a CSS file:

mdpdf input.md -o output.pdf -s styles.css

Specifying Header and Footer

Add a custom header and footer to your PDF:

mdpdf input.md -o output.pdf --header "Header text" --footer "Footer text"

Setting Page Margins

Define custom page margins:

mdpdf input.md -o output.pdf --margin 20

Generating a Table of Contents

Automatically generate a table of contents:

mdpdf input.md -o output.pdf --toc

Password Protection

Protect your PDF with a password:

mdpdf input.md -o output.pdf --password "yourpassword"

Embedding Fonts

Embed custom fonts in your PDF:

mdpdf input.md -o output.pdf --fonts "path/to/fonts"

Full App Example

Here’s a comprehensive example of using multiple mdpdf APIs in a single app:

const mdpdf = require('mdpdf');

const options = {
  source: 'input.md',
  destination: 'output.pdf',
  stylesheet: 'styles.css',
  header: 'Custom Header',
  footer: 'Custom Footer',
  margin: 20,
  toc: true,
  password: 'yourpassword',
  fonts: 'path/to/fonts',
};

mdpdf.convert(options)
  .then(() => {
    console.log('Conversion successful!');
  })
  .catch(err => {
    console.error('Error during conversion:', err);
  });

This script leverages various mdpdf options to produce a customized PDF with a table of contents, password protection, custom styles, and embedded fonts.

Hash: 9a4f853e5ce1f13baa8a6f0edecb6899a3d4673f8c93e35488899648378ee027