Skip to content

A simple framework for publishing online books.

License

Notifications You must be signed in to change notification settings

UnstableDesign/peruse

 
 

Repository files navigation

Peruse

This is a simple framework for publishing online books. I originally created it to make it easier to maintain the many online books on my website (amyjko.com), while adding more sophisticated features to support reading.

Project status

This is very much an alpha that I use for my own book publishing. I have aspirations to make it usable for others in the future, I just don't have much time to code these days, which are full of research, teaching, and service! Maybe I'll work on this in sabbatical in 2022-23, so it's something others can use to publish books.

Viewing Books Locally

To build assets and view a book on a local server, you can use the following command (after install dependecies with npm):

$ npm run book -- path/to/book

For example, the following command will open a new browser tab with an example tutorial book:

$ npm run book -- examples/tutorial

About

A simple framework for publishing online books.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 90.7%
  • CSS 9.1%
  • Shell 0.2%