mirror of https://github.com/neroist/nim-wkhtmltox synced 2026-01-15 06:51:35 +00:00

No description

Find a file

Grave 95c2093c29 Update README.md		2023-05-10 11:36:40 -04:00
examples	remove "true"	2023-04-26 11:58:49 -04:00
src	fix	2023-05-10 11:31:49 -04:00
tests	First commit	2023-04-26 11:25:05 -04:00
.gitignore	add libwkhtmltox DLLs	2023-05-03 00:34:38 -04:00
LICENSE	First commit	2023-04-26 11:25:05 -04:00
nimwkhtmltox.nimble	change version	2023-05-10 11:31:39 -04:00
README.md	Update README.md	2023-05-10 11:36:40 -04:00

README.md

nim-wkhtmltox

Nim bindings to wkhtmltox.

Distributing

This library depends on the wkhtmltox DLL, so please package it when distributing your application.

You can use -d:wkImageLib and -d:wkPdfLib to control what directory the DLLs are looked for, for the image and pdf submodules respectively.

Get Started

You can get started with the examples listed here or in the examples/ directory.

Documentation

Follow libwkhtmltox's directly here (Archive)

Examples

To PDF:

import nimwkhtmltox/pdf

initPdf()

# from w3schools
let content = """
<!DOCTYPE html>
<html>
<head>
  <style>
    h1 {
      color: blue;
      font-family: verdana;
      font-size: 300%;
    }

    p  {
      color: red;
      font-family: courier;
      font-size: 160%;
    }
  </style>
</head>
<body>

  <h1>This is a heading</h1>
  <p>This is a paragraph.</p>

</body>
</html>
"""

let settings = createGlobalSettings()
settings.setGlobalSetting("out", "./index.pdf")

let conv =  createConverter(settings)

let objSettings = createObjectSettings()

conv.addObject(objSettings, content)

conv.convert()

deinitPdf()

import nimwkhtmltox/pdf

initPDF()

toPDF(
  "https://wkhtmltopdf.org/libwkhtmltox/pagesettings.html",
  createGlobalSettings({
    "out": "pagesettings.pdf"
  })
)

deinitPDF()

To Image:

import nimwkhtmltox/image

initImage()

let settings = createGlobalSettings()
settings.setGlobalSettings({
  "in": "https://spdx.org/licenses/LGPL-3.0-or-later.html",
  "out": "license.png",
  "fmt": "png"
})

let conv = createConverter(settings, "")

conv.convert()

deinitImage()

import nimwkhtmltox/image

initImage()

toImage(
  "https://github.com/neroist/nim-wkhtmltox",
  createGlobalSettings({
    "out": "nim-wkhtmltox.png",
    "fmt": "png"
  })
)

deinitImage()