# @vivliostyle/viewer

> Vivliostyle Viewer - HTML+CSS typesetting and rich paged viewing with EPUB/Web publications support

Latest version **2.45.1** (published 2026-09-06) · AGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @vivliostyle/viewer
pnpm add @vivliostyle/viewer
yarn add @vivliostyle/viewer
bun add @vivliostyle/viewer
```

## Health

**Score 60/100 (C)** — status: active.

Positive: no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 2.45.1 |
| Published | 2026-09-06 |
| First published | 2019-12-15 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=20 |
| Dependencies | 3 |
| Unpacked size | 5.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 790 |
| Author | Vivliostyle Foundation |
| Maintainers | mshinyu, uetchy, akabeko, youchan, spring-raining, johanneswilm, yamasy1549, u1f992 |
| Keywords | vivliostyle |

## Links

- npm: https://www.npmjs.com/package/@vivliostyle/viewer
- Repository: https://github.com/vivliostyle/vivliostyle.js
- Homepage: https://github.com/vivliostyle/vivliostyle.js/tree/master/packages/viewer
- Issues: https://github.com/vivliostyle/vivliostyle.js/issues
- npm.io page: https://npm.io/package/@vivliostyle/viewer

## Dependencies (3)

- [knockout](https://npm.io/package/knockout.md) ^3.5.0
- [i18next-ko](https://npm.io/package/i18next-ko.md) ^3.0.1
- [@vivliostyle/core](https://npm.io/package/@vivliostyle/core.md) ^2.45.1

## Recent versions

- 2.45.1 (latest) — 2026-09-06
- 2.45.0 — 2026-08-22
- 2.44.1 — 2026-07-09
- 2.44.0 — 2026-07-04
- 2.43.3 — 2026-06-18
- 2.43.2 — 2026-06-12
- 2.43.1 — 2026-06-09
- 2.43.0 — 2026-05-22
- 2.42.1 — 2026-05-13
- 2.42.0 — 2026-04-25
- 2.41.0 — 2026-04-11
- 2.40.0 — 2026-01-11
- 2.39.1 — 2025-12-27
- 2.39.0 — 2025-12-25
- 2.38.0 — 2025-12-18
- … 141 more at https://npm.io/package/@vivliostyle/viewer/versions

## README

# Vivliostyle Viewer

[![npm][npm]][npm-url]
[![Install Size][size]][size-url]
[![Downloads][downloads]][downloads-url]

Vivliostyle Viewer is a Web application for HTML+CSS typesetting and rich paged viewing with EPUB/Web publications support.

- Online Vivliostyle Viewer: <https://vivliostyle.org/viewer/>
- Download Vivliostyle Viewer: <https://vivliostyle.github.io>
- View samples online: <https://vivliostyle.org/samples/>

## How to use

### To use the distribution package `vivliostyle-viewer-*.zip`

1. Unzip the downloaded ZIP file.
2. Open a terminal (or Windows command prompt)
3. Run the `start-webserver` or `start-viewer` script (or Windows batch) file located in the unzipped directory. For example:

```
$ ./vivliostyle-viewer-latest/start-webserver
```

or in Windows command prompt,

```
> vivliostyle-viewer-latest\start-webserver
```

If a message,

```
Please install Node.js or Ruby or Python and rerun this script, or use your favorite HTTP server.
```

is shown, install either of them (recommend [Node.js](https://nodejs.org/) and rerun the script, or use your favorite web server.

The `start-webserver` script starts a local web server and opens the default browser. The current directory is used as the root of the web server. Run `start-webserver --help` to see the usage help.

The `start-viewer` script starts a local web server (calls `start-webserver`) and opens Vivliostyle Viewer (located in `./viewer/`) in browser. Run `start-viewer --help` to see the usage help.

### To use the npm package [`@vivliostyle/viewer`](https://www.npmjs.com/package/@vivliostyle/viewer)

```
npm install @vivliostyle/viewer
```

Vivliostyle Viewer is located in `./node_modules/@vivliostyle/viewer/lib/`, so you need to start a web server and open this location in the browser to start the Vivliostyle Viewer.

## Documentation

See online [Vivliostyle Documents](https://vivliostyle.org/documents/) for the latest documents, or open `./docs/` in the distribution package using local web server.

## Bug reports & feature requests

Please send them to

- GitHub Issues: <https://github.com/vivliostyle/vivliostyle.js/issues>

## Source code

- Vivliostyle.js on GitHub: <https://github.com/vivliostyle/vivliostyle.js>

## License

Licensed under [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.html).

[npm]: https://img.shields.io/npm/v/@vivliostyle/viewer/latest
[npm-next]: https://img.shields.io/npm/v/@vivliostyle/viewer/next
[npm-url]: https://www.npmjs.com/package/@vivliostyle/viewer
[size]: https://packagephobia.vercel.app/badge?p=@vivliostyle/viewer
[size-url]: https://packagephobia.vercel.app/result?p=@vivliostyle/viewer
[downloads]: https://img.shields.io/npm/dw/@vivliostyle/viewer.svg
[downloads-url]: https://www.npmjs.com/package/@vivliostyle/viewer

---
_Source: https://npm.io/package/@vivliostyle/viewer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._