DjVu.js is a program library for working with .djvu
online. It's written
in JavaScript and can be run in a web browser without any connection with a
server. DjVu.js can be used for splitting (and concatenation) of .djvu
files,
rendering pages of a .djvu
document, converting (and compressing) images
into .djvu
documents and for analyzing of metadata of .djvu
documents.
DjVu.js Viewer is an app which uses DjVu.js to render DjVu documents. The app may be easily included into any html page. You can look at it and try it out on the official website (the link is below).
DjVu.js Viewer browser extension. By and large, it's a copy of the viewer,
but also it allows opening links to .djvu
files right in the browser without
downloading them explicitly. The links to the extension are below.
DjVu.js - это программная библиотека написанная на JavaScript и
предназначенная для работы с файлами формата .djvu
онлайн. DjVu.js
ориентирована на исполнение в браузере пользователя без связи с сервером.
Библиотека может быть использована для разделения (объединения) файлов .djvu
,
преобразования картинок в документы .djvu
, отрисовки страниц
документов .djvu
, а также для анализа мета данных и структуры .djvu
документов.
DjVu.js Viewer - приложение, которое можно легко встроить в любую html-страницу. Данное приложение служит для просмотра документов DjVu непосредственно в браузере. Вы можете ознакомиться с ним по ссылке ниже.
Расширение для браузера DjVu.js Viewer. По большей части это копия
приложения DjVu.js Viewer, однако также расширение позволяет открывать ссылки
на .djvu
файлы прямо в браузере, не скачивая их явно. Ссылки на расширение
доступны ниже.
If you want to add a new translation to the viewer read here how to do it.
You need to have Node.js 18+ (although older versions should work too) and npm 9+ installed to work with the project.
The viewer and the library are supposed to run in a browser. Technically, it should not be difficult to update the library so that it could be used in Node.js projects - the main code is pure JS and doesn't rely on browser specific APIs.
Currently, the following browsers are supported:
Chrome >= 88
Firefox >= 78
Safari >= 14
Edge >= 88
The list above is conditioned by the default Vite settings
and the support of the :where
CSS pseudo class.
Clone the repo and run:
npm run install
npm run build
in the root folder of the repository. The command will install all dependencies
and create bundles of the library and viewer (the build
folder should
appear).
Also, there is another way to do the same operations:
npm run make
The command will clean all git-ignored files, install all the dependencies and
build the library and viewer. However, you should have git
installed
and the repository should have the .git
folder (there is no one in the
source code uploaded to the browser extensions websites).
If you want to work with the library you should read the library's README.
As for the viewer, you have to build the library once and start the dev server. It can be achieved with the following commands:
npm run make # run it only once
cd viewer
npm start
A page with the viewer will open automatically.
Once the dev server has been started, you can run E2E tests via test*
npm scripts that you can find in
the viewer/package.json
file.
After the two commands above are executed (install
and build
), the extension
folder will contain all the necessary files, that is to say, the folder is an
unpacked extension. If you want to pack the extension, you should have
the web-ext
module installed globally, to wit, npm install web-ext -g
, and
then just change the directory:
cd extension
and run
web-ext build
and the packed version of the extension will appear in the extension folder.
If you have some problems, read the technical documentation or create an issue. Also, you can download the library from the official website. (All links are below).
- The official website with the DjVu.js Viewer demo is https://djvu.js.org
- You may download the library and the viewer on https://djvu.js.org/downloads
- The browser extension for Mozilla Firefox
- The browser extension for Google Chrome
- The technical documentation of the library is available in the wiki
- CHANGELOG of the library
- CHANGELOG of the viewer
The DjVu.js Library is distributed under the terms of GNU GPL v2. Everything else in this repository (including the DjVu.js Viewer and the browser extension) is under The Unlicense. Read more in the LICENSE file.
Библиотека DjVu.js распространяется под лицензией GNU GPL v2. Все остальное в этом репозитории (включая DjVu.js Viewer и расширение для браузера) является общественным достоянием (The Unlicense). Читайте подробнее в файле лицензии.