getting-started.md

layout	page
title	Getting Started

{% capture viewer_frame1_description %}

Page view to fit window size

 {% endcapture %}

{% capture viewer_frame2_description %}

Page view by fixed size

 {% endcapture %}

{% include assign/array.html description1=viewer_frame1_description description2=viewer_frame2_description %}{% assign viewer_frames = array %}

{% capture viewer %}

Vivliostyle Viewer {{ site.data.project.viewer.version }}

• A browser-based formatting engine that reads HTML and displays the results of the typesetting in the browser.
• 💡To use Vivliostyle in a local environment, the recommend tool is Vivliostyle CLI, which includes the Vivliostyle Viewer. 👉Vivliostyle CLI User Guide

{% include button/primary.html url=site.data.project.viewer.url text="Use Vivliostyle Viewer" %} {% include button/github.html url=site.data.project.viewer.github text="README" %}

{% include frame-list.html frames=viewer_frames %}

For more information about Vivliostyle Viewer, see Vivliostyle Viewer User Guide.

{% endcapture %}

{% capture cli_frame1_description %}

How to install

• You need to install Node.js prior to using it.
• It can be installed from the npm package.

Vivliostyle CLI will be released as an npm package. Also, Node.js must be installed.

$ npm install -g @vivliostyle/cli

{% endcapture %}

{% capture cli_frame2_description %}

Create PDF from HTML

• On the command line you can use the build command to specify an HTML file to convert into a PDF file typeset with CSS.

In the Terminal command line, run it with your HTML file to output PDF file with CSS typesetting. There is also a preview option.

$ vivliostyle build index.html

{% endcapture %}

{% capture cli_frame3_description %}

Preview

• With the preview command, you can check what the results would look like.
• Use -h to see details of the usage. Also check the help help [cmd] for each command.

$ vivliostyle preview index.html

 {% endcapture %}

{% include assign/array.html description1=cli_frame1_description description2=cli_frame2_description description3=cli_frame3_description %}{% assign cli_frames = array %}

{% capture cli %}

Vivliostyle CLI {{ site.data.project.cli.version }}

• CSS typesetting on the command line with output to PDF.
• PDF/X-1a output supported by merging PRESS-READY in v2. Ghostscript and Xpdf are required for this feature. See PRESS-READY for more information.

{% include button/github.html url=site.data.project.cli.github text="README" %}

{% include frame-list.html frames=cli_frames %}

For more information about Vivliostyle CLI, see Vivliostyle CLI User Guide.

{% endcapture %}

{% capture pub %}

Vivliostyle Pub {{ site.data.project.pub.version }}

• This is a web application that allows you to use Vivliostyle without installation.
• You can edit text / Markdown / HTML in the left pane and preview the typesetting result in the right pane.
• From 2025, the new Vivliostyle Pub is being developed. You can try the new Alpha version at the following URL:
  • https://alpha.vivliostyle.pub/
• For the old Alpha version, you can find information at Vivliostyle Pub α Version User Guide.


{% endcapture %}

{% include page/getting_started.html title="Getting Started" lead="Vivliostyle currently consists of two products. This page will show you how to use it. In addition, we will also present a new service that is currently in alpha."

viewer=viewer cli=cli pub=pub %}