Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chocolatkey/xbreader

The X-tra Beautiful comic reading interface (In development)
https://github.com/chocolatkey/xbreader

Last synced: 20 days ago
JSON representation

The X-tra Beautiful comic reading interface (In development)

Host: GitHub
URL: https://github.com/chocolatkey/xbreader
Owner: chocolatkey
License: mit
Created: 2018-07-22T04:45:43.000Z (over 6 years ago)
Default Branch: develop
Last Pushed: 2024-05-12T04:49:19.000Z (8 months ago)
Last Synced: 2024-12-03T13:11:30.610Z (about 1 month ago)
Language: TypeScript
Homepage:
Size: 1.85 MB
Stars: 29
Watchers: 9
Forks: 4
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-readium - xbreader - a manga viewer written in TypeScript (Compatible with Readium Web Publications / Other apps)

README

        # xbreader

[![Version](https://badgen.net/npm/v/xbreader)](https://www.npmjs.com/package/xbreader)

[![BundlePhobia](https://badgen.net/bundlephobia/minzip/xbreader)](https://bundlephobia.com/result?p=xbreader)

[![PackagePhobia](https://badgen.net/packagephobia/install/xbreader)](https://packagephobia.now.sh/result?p=xbreader)

[![License](https://badgen.net/npm/license/xbreader)](https://www.npmjs.com/package/xbreader)

[![Downloads](https://badgen.net/npm/dt/xbreader)](https://www.npmjs.com/package/xbreader)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fchocolatkey%2Fxbreader.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fchocolatkey%2Fxbreader?ref=badge_shield)

> A fixed-layout publication reader for the web

## Setup

add xbreader as a dependency

```bash

npm install xbreader

yarn add xbreader

```

or use over a cdn

```bash

https://cdn.jsdelivr.net/npm/xbreader/dist/xbreader.js

https://cdn.jsdelivr.net/npm/xbreader/dist/xbstyles.css

or

https://unpkg.com/xbreader/dist/xbreader.js

https://unpkg.com/xbreader/dist/xbstyles.css

```

## Configuration

window.xbreader takes an XBConfig instance. Click [here](https://github.com/chocolatkey/xbreader/blob/master/src/app/components/Reader.ts#L78) for the default configuration.

## Documentation

Coming Soon!

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fchocolatkey%2Fxbreader.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fchocolatkey%2Fxbreader?ref=badge_large)