GithubHelp home page GithubHelp logo

emacle / booki-d-sh-reader Goto Github PK

View Code? Open in Web Editor NEW

This project forked from amyjko/bookish-reader

0.0 0.0 0.0 2.99 MB

License: MIT License

JavaScript 5.02% TypeScript 53.96% HTML 6.27% Svelte 28.86% Shell 5.89%

booki-d-sh-reader's Introduction

Bookish Reader

This is a companion repository to Bookish, which uses packaged components from Bookish to create a standalone Reader app that reads a book.json file from the root folder of the Reader, and chapters from the chapters folder in the root.

Assuming you have npm installed, set up a book as follows:

  • Install the reader npm install bookish-reader
  • Build the reader npm run build
  • Copy everything in the resulting build folder to wherever your book folder is hosted.

That's it!

Bookish Reader is currently in beta; it is not yet ready for production.

How it works

Bookish is written in SvelteKit, and as is Bookish Reader, and so the compiled app is a SvelteKit app. The build step above uses SvelteKit's [static adapter])(https://github.com/sveltejs/kit/tree/master/packages/adapter-static) to generate a static site. However, it makes a few assumptions about how the book will be hosted; the defaults here assume a web server that will fall back to index.html when a page doesn't exist, among other things. You may need to update some of the build settings to property configure it for your hosting environment.

booki-d-sh-reader's People

Contributors

amyjko avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.