Markdown conversion and screenshots

The Markdown route needs an index.html (template/layout) and a Markdown file. Gotenberg supports MathJax for math in Markdown. Your index.html must include the Go template action where the content should appear: {{ toHTML "file.md" }} (use the actual Markdown filename). See Gotenberg’s Markdown conversion for template details. Gotenberg renders the Markdown into the HTML and then converts or captures.

Convert Markdown to PDF

import { MarkdownConverter } from "chromiumly";

const markdownConverter = new MarkdownConverter();
const buffer = await markdownConverter.convert({
  html: "path/to/index.html",
  markdown: "path/to/document.md",
});

Both html and markdown can be a file path string, Buffer, or ReadStream. Add conversion options (e.g. properties, header, footer) to the same object. markdown also accepts an array of distinctly-named files, all referenced from the same index.html template:

const buffer = await markdownConverter.convert({
  html: "path/to/index.html",
  markdown: [
    { file: "path/to/chapter1.md", name: "chapter1.md" },
    { file: "path/to/chapter2.md", name: "chapter2.md" },
  ],
});

Both the convert and screenshot routes also accept an optional assets field for images, stylesheets, or other files referenced from the HTML/Markdown content:

const buffer = await markdownConverter.convert({
  html: "path/to/index.html",
  markdown: "path/to/document.md",
  assets: [{ file: "path/to/style.css", name: "style.css" }],
});

Capture Markdown as screenshot

import { MarkdownScreenshot } from "chromiumly";

const screenshot = new MarkdownScreenshot();
const buffer = await screenshot.capture({
  html: "path/to/index.html",
  markdown: "path/to/document.md",
});

Use properties for image format and dimensions. See Options.

Getting started

Chromium

LibreOffice

PDF engines

Advanced

Markdown conversion and screenshots

Convert Markdown to PDF

Capture Markdown as screenshot

​Convert Markdown to PDF

​Capture Markdown as screenshot

Convert Markdown to PDF

Capture Markdown as screenshot