https://github.com/rhdunn/document-viewer

A browser-based ePub viewer written in XQuery.
https://github.com/rhdunn/document-viewer

basex epub epub-reader epub3 xquery

Last synced: 29 days ago
JSON representation

A browser-based ePub viewer written in XQuery.

• Host: GitHub
• URL: https://github.com/rhdunn/document-viewer
• Owner: rhdunn
• License: apache-2.0
• Created: 2021-04-25T17:33:40.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-09-23T07:00:08.000Z (over 2 years ago)
• Last Synced: 2024-10-15T10:34:15.273Z (3 months ago)
• Topics: basex, epub, epub-reader, epub3, xquery
• Language: XQuery
• Homepage:
• Size: 63.5 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Document Viewer

This is a web-based document viewer for the following document formats:

1. ePub 2 and 3.

## Setup

To run this project, you need to copy a BaseX installation into the project

directory and ignore/skip any files that will be overrided (or run the

`git checkout -f` command after copying the files over).

You can then start the HTTP server by running the `bin/basexhttp` command.

## Usage

These examples use the default BaseX path of `http://localhost:8984`. Replace

that with the server name and port you are running on.

To view the contents of a directory, use:

    http://localhost:8984/?path=[path-to-directory]

Any directories and viewable documents will be displayed as clickable links.

Other files will be displayed as text.

To view an ePub file, use:

    http://localhost:8984/?path=[path-to-epub.epub]

When viewing a directory or document, there will be a "Back" button on the top

right that navigates up to the parent directory.

## License

Copyright (C) 2021 Reece H. Dunn

The document viewer project is licensed under the [Apache 2.0](LICENSE) license.