📘
prose
  • Get Started
    • Introduction
    • Demo & Showcase
    • Contact / Community / Links
    • Getting started
    • Core concepts
    • Troubleshooting / FAQ
  • Alternatives
  • Learn
    • Core
    • Streamer
      • Node
      • React Native
      • Service Worker
      • Web (dom)
      • Hooks
    • Enhancers
    • Viewport
    • Hooks
    • Pagination
    • Settings
    • Context
    • Navigation
    • Selection
    • Links
    • Zoom
    • PDF
  • CORE API
    • reader
      • links$
      • locateResource()
    • viewport
    • navigation
  • zoom
  • enhancers
    • PDF
    • Gestures
    • Gallery
    • Search
    • Annotations
    • Bookmarks
  • React Reader
    • Introduction
    • Getting Started
  • CFI
    • About
Powered by GitBook
On this page

Was this helpful?

  1. Get Started

Introduction

NextDemo & Showcase

Last updated 2 months ago

Was this helpful?

Welcome to the prose documentation. Prose is an open source and free Reading System SDK to display epub and general archives (zip, cbz, cbr, etc) on the browser.

It is similar to what powers apps like Kindle, Kobo and other reading app alike. Unlike proprietary engines, this one is free and made for the community. It is designed to allow plugins and extends functionalities easily.

In a nutshell, a reading system SDK will let you design your own reader the way you want while not having to deal with the complicated parts such as rendering, pagination, navigation, annotations, etc.

This engine is web based. Using it in native apps is an expected use case but will require a WebView or similar to be integrated.

This doc is under writing and heavily incomplete. I have way more fun developing rather than writing doc. That being said, I encourage you to join the discord or leave issues on the github repo and I will gladly help you