ReLaXed README

The project's README from github.com/RelaxedJS/ReLaXed. As one markdown file: README.md.

ReLaXed

Build Status

ReLaXed creates PDF documents interactively using HTML or Pug (a shorthand for HTML). It allows complex layouts to be defined with CSS and JavaScript, while writing the content in a friendly, minimal syntax close to Markdown or LaTeX.

Here it is in action in the Atom editor:

And here are a few output examples:

Book - source / PDF Letter - Source / PDF Resume - Source / PDF Visit card - Source / PDF
Slides - Source / PDF Report - Source / PDF Paper - Source / PDF Poster - Source / PDF

ReLaXed has support for Markdown, LaTeX-style mathematical equations (via MathJax), CSV conversion to HTML tables, plot generation (via Vega-Lite or Chart.js), and diagram generation (via mermaid). Many more features can be added simply by importing an existing JavaScript or CSS framework.

Installing ReLaXed

Install ReLaXed via NPM with this command (do not use sudo):

npm i -g relaxedjs

This will provide your system with the relaxed command. If the installation fails, refer to the troubleshooting page. You can also use ReLaXed via Docker (see this repository)

Getting started

To start a project, create a new document my_document.pug with the following Pug content:

h1 My document's title
p A paragraph in my document

Then start ReLaXed from a terminal:

relaxed my_document.pug

ReLaXed will generate my_document.pdf from my_document.pug, then watch its directory and subdirectories so that every time a file changes, my_document.pdf will be re-generated.

It is also possible to generate the PDF file just once, with no sub-sequent file-watching, with this command:

relaxed my_document.pug --build-once

To go further:

Why yet another PDF document creator?

Many of us prefer markup languages (Markdown, LaTeX, etc.) to GUI document-editors like MS Office or Google Docs. This is because markup languages make it easier to quickly write documents in a consistent style.

However, Markdown is limited to the title/sections/paragraphs structure, and LaTeX has obscure syntax and errors that also make it difficult to stray from the beaten track.

On the other hand, web technologies have never looked so good.

ReLaXed is an attempt at finding the most comfortable way to leverage this for desktop PDF creation.

How ReLaXed works

ReLaXed consists of a few lines of code binding together other software. It uses Chokidar to watch the file system. When a file is changed, several JavaScript libraries are used to compile SCSS, Pug, Markdown, and diagram files (mermaid, flowchart.js, Chart.js) into an HTML page which is then printed to a PDF file by a headless instance of Chromium (via Puppeteer).

Using it as a Node Module

MasterToPDF.js is exposed by default as main package, which can be used directly.

An Example: 

const { masterToPDF } = require('relaxedjs');
const puppeteer = require('puppeteer');
const plugins = require('relaxedjs/src/plugins');
const path = require('path');

class HTML2PDF {
  constructor() {
    this.puppeteerConfig = {
      headless: true,
      args: [
        '--no-sandbox',
        '--disable-translate',
        '--disable-extensions',
        '--disable-sync',
      ],
    };

    this.relaxedGlobals = {
      busy: false,
      config: {},
      configPlugins: [],
    };

    this._initializedPlugins = false;
  }

  async _initializePlugins() {
    if (this._initializedPlugins) return; // Do not initialize plugins twice
    for (const [i, plugin] of plugins.builtinDefaultPlugins.entries()) {
      plugins.builtinDefaultPlugins[i] = await plugin.constructor();
    }
    await plugins.updateRegisteredPlugins(this.relaxedGlobals, '/');

    const chrome = await puppeteer.launch(this.puppeteerConfig);
    this.relaxedGlobals.puppeteerPage = await chrome.newPage();
    this._initializedPlugins = true;
  }

  async pdf(templatePath, json_data, tempHtmlPath, outputPdfPath) {
    await this._initializePlugins();
    if (this._initializedPlugins) {
      // Paths must be absolute
      const defaultTempHtmlPath = tempHtmlPath || path.resolve('temp.html');
      const defaultOutputPdfPath =
        outputPdfPath || path.resolve('output.pdf');

      await masterToPDF(
        templatePath,
        this.relaxedGlobals,
        defaultTempHtmlPath,
        defaultOutputPdfPath,
        json_data
      );
    }
  }
}

module.exports = new HTML2PDF();

Usage:

const HTML2PDF = require('./HTML2PDF.js');
(async () => {
    await HTML2PDF.pdf('./template.pug', {"a":"b", "c":"d"});
})();

Contribute!

ReLaXed is an open-source framework originally written by Zulko and released on Github under the ISC licence. Everyone is welcome to contribute!

For bugs and feature requests, open a Github issue. For support or Pug/HTML-related questions, ask on Stackoverflow or on the brand new reddit/r/relaxedjs forum, which can be used for any kind of discussion.

Projects members:

License

ISC

ReLaXed (RelaxedJS/ReLaXed)

Searching Database…

11.8K ·GitHub
ReLaXed
Что это такое?ReLaXed — инструмент, который позволяет писать документы на Pug или HTML и превращать их в PDF-файлы. Верстку можно делать с помощью CSS и JavaScript, а не бороться с LaTeX или графическим редактором.
Это графический редактор или инструмент командной строки?Это инструмент командной строки. Вы пишете файлы Pug/HTML в любом текстовом редакторе, а затем запускаете команду 'relaxed'. Она отслеживает файлы и заново создает PDF при каждом сохранении.
Как мне установить и создать первый PDF?Установите глобально через NPM без sudo, это даст команду 'relaxed'. Затем запустите 'relaxed mydocument.pug', чтобы отслеживать файл и постоянно пересобирать PDF, или добавьте флаг, чтобы собрать документ один раз и остановиться.
Что на самом деле работает за кулисами, чтобы получился PDF?Chokidar отслеживает ваши файлы. Несколько JS-библиотек компилируют SCSS, Pug, Markdown и диаграммы в HTML-страницу, а затем эта страница печатается в PDF экземпляром headless Chromium, которым управляет Puppeteer.
Есть ли известные подводные камни при установке?Да, в README прямо сказано, что установка через NPM может завершиться ошибкой, и дана ссылка на отдельную страницу с решением проблем. Вероятно, это связано со сборкой headless Chromium через Puppeteer.
Работает ли это на любой ОС и есть ли вариант с Docker?Благодаря headless Chromium через Puppeteer ReLaXed работает на Linux, macOS и Windows. Также есть отдельный образ Docker, который поддерживается в другом репозитории, если не хотите устанавливать программу локально.
Поддерживает ли ReLaXed математические формулы, CSV-таблицы и диаграммы?Да: поддерживаются формулы в стиле LaTeX через MathJax, преобразование CSV в HTML-таблицы, графики через Vega-Lite или Chart.js и диаграммы через Mermaid. Все это можно использовать внутри ваших файлов Pug/HTML.
Можно ли использовать ReLaXed как библиотеку Node.js вместо командной строки?Да: его основной модуль (MasterToPDF.js) доступен как главный экспорт пакета, поэтому его можно вызывать прямо из вашего кода на Node.js, не запуская командную строку.
Зачем автор создал это, а не использовал LaTeX или MS Word?Автор хотел сочетать аккуратное современное оформление CSS-фреймворков и огромную экосистему JavaScript (графики, подсветка синтаксиса, формулы) с легковесной разметкой вроде Pug. При этом он хотел избежать сложного синтаксиса LaTeX и непоследовательности графических редакторов.
What are similar projects?bentopdf, handout-remake, sghtmltopdf, liteparse, pandoc, gotenberg, Filee, MiniPdf
Which topics is it in?pdf-converter, pdf-generation, headless-browser, puppeteer, scss, document, converter, chromium, csv, latex, charts, document-processing
Creator
RelaxedJS
Size
0.8 MB
Stars
11.8K
Updated
CommitSep 07
Age
8y
Commits · 90 Days