Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/divine-software/ghostly

Ghostly template/print formatter engine
https://github.com/divine-software/ghostly

css html pdf playwright print-formatter template-engine

Last synced: 3 months ago
JSON representation

Ghostly template/print formatter engine

Host: GitHub
URL: https://github.com/divine-software/ghostly
Owner: Divine-Software
License: other
Created: 2016-06-09T09:52:56.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-09-27T12:18:15.000Z (4 months ago)
Last Synced: 2024-10-10T04:41:09.120Z (3 months ago)
Topics: css, html, pdf, playwright, print-formatter, template-engine
Language: TypeScript
Homepage: https://divine-software.github.io/ghostly/
Size: 4.37 MB
Stars: 2
Watchers: 3
Forks: 2
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# The Ghostly template/print formatter engine

[![ghostly-cli version](https://badge.fury.io/js/%40divine%2Fghostly-cli.svg)](https://badge.fury.io/js/%40divine%2Fghostly-cli)
[![ghostly-engine version](https://badge.fury.io/js/%40divine%2Fghostly-engine.svg)](https://badge.fury.io/js/%40divine%2Fghostly-engine)
[![ghostly-runtime version](https://badge.fury.io/js/%40divine%2Fghostly-runtime.svg)](https://badge.fury.io/js/%40divine%2Fghostly-runtime)

*Ghostly* is a template engine/print formatter that can be used to render HTML or PDF documents, images and other kinds
of documents from a data model or parameter set.

The templates are just a web page with a very simple API that should be implemented, which means that any normal
front-end technology can be used for the actual rendering. This also makes the templates incredibly powerful, much more
so than traditional template languages or XSLT stylesheets.

The *Ghostly Engine* is available as a [Node.js module](https://www.npmjs.com/package/@divine/ghostly-engine) with a
really simple API that you can embed in your own project. There is also a [command line
tool](https://www.npmjs.com/package/@divine/ghostly-cli) that can either render documents from the command line or start
a web service that accepts HTTP requests, enabling use from any language or environment. This tool is also available as
a ready-made [Docker image](https://hub.docker.com/r/divinesoftware/ghostly).

The *Ghostly Runtime* is a small [client-side library](https://www.npmjs.com/package/@divine/ghostly-runtime) that
defines the protocol required to drive the template.

Ghostly version 1 has been used in production for several years. Version 2 is a major rewrite which uses a modern
[headless browser engine](https://playwright.dev/) and adds support for generating arbitrary attachments as part of the
rendering operation.

Please visit our [web site](https://divine-software.github.io/ghostly/) for more information.