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|
Install ReLaXed via NPM with this command (do not use
npm i -g relaxedjs
This will provide your system with the
relaxed command. If the installation fails, refer to the troubleshooting page.
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 will generate
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:
- Read more about usage and options of the
- Learn more about the capabilities of the Pug language
- Learn how to use or write ReLaXed plugins
- Browse the examples
- Read about our recommended setup to use ReLaXed
- read about special file rendering in ReLaxed
- Read these comparisons between ReLaXed and other document-editing systems
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.
- Beautiful CSS frameworks make sure your documents look clean and modern.
- Millions of people (and growing) know how to use these.
- Shorthand languages like Pug and SCSS are finally making it fun to write HTML and CSS.
- (Headless) web browsers can easily turn web documents into PDF, on any platform.
ReLaXed is an attempt at finding the most comfortable way to leverage this for desktop PDF creation.
How ReLaXed works
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.