Repository navigation
Releases: techczech/onlinereaderframework
Release list
Online Reader Framework v1.1.0
Online Reader Framework 1.1.0 adds interactive examples and a runnable example book. Books and code written for 1.0.0 work without changes.
Interactive examples. A host can place a self-contained HTML document, such as a diagram or a simulator, before a passage of a chapter. It runs in a frame with sandbox="allow-scripts" only, so it has no access to the page, the reader's notes, storage, cookies, pop-ups or the network. The passage is its written text version, and search, notes, read-aloud, EPUB and agent files use that text. New exports: checkPublicationEmbeds, validatePublicationEmbeds, resolvePublicationEmbedUrl, readPublicationEmbedHeight, PublicationEmbedFrame, PublicationEmbedSlots, and reader-core/embed-child for use inside an embed.
Hosting. The embed folder must be served with a Content-Security-Policy header that includes sandbox allow-scripts and blocks network access, so that an embed opened on its own stays sandboxed. The example build writes this header for Cloudflare Pages in _headers, and its local preview sends it. GitHub Pages cannot send custom headers; build without embeds for it (npm run example:no-embeds).
Example book. examples/reader-example is a short book of invented demonstration text under the MIT licence, with chapters inside chapters, formatting, one interactive example, an EPUB download and agent files. npm run setup, npm run build, npm run example, npm run example:preview.
Also changed. Front-page actions show icons; a link to a passage taller than the screen scrolls to its start. The README and project page list five live editions, including Increasing Reading Productivity and Foundations of Readability.
The package is still not on npm. Software: MIT. Fonts: SIL Open Font License 1.1. Published books are not included and not covered. Full list: CHANGELOG.md.
Online Reader Framework v1.0.0
Online Reader Framework v1.0.0 is an MIT-licensed React library for publishing books, guides and other long texts on the web.
- Each publication can have its own appearance and one of six front-page layouts, with nested contents and chapter outlines.
- Readers get full-text search, highlights, notes, bookmarks and reading progress saved in their browser.
- Reading tools include adjustable typography, paragraph focus, line windows, a ruler, anchored reading and a theme that follows the computer.
- Browser read-aloud offers voice selection, passage skipping and text highlighting. Hosts can supply recorded audio separately.
- Books can be exported as EPUBs in the browser, and hosts can generate full-text Markdown and chapter files for AI agents.
The design draws on Foundations of Readability and the Academic Reading Framework, with further guidance in Principles of Readability.
See the README for setup, the book format and usage examples. This release is distributed as source; it is not published on npm. Browser speech depends on the voices available on the reader’s device.
The MIT grant covers the framework software. Books are not included; bundled font notices and dependency terms remain separate, as explained in LICENSING.md.
The attached source archive contains the reviewed 125-file snapshot. Its SHA-256 is 502b7a14a3eb030a34a1038d249b2cd0f50a910a89883f365b2e6b9c29988e0b.