Easy Peasy EBook is a prototype of a minimal epub creation tool based on GitHub, Mavo, CSS-grids, Puppeteer and Epubcheck. We probably don't really need another Github-based ebook tool, so this is mostly for experimenting with Mavo as a way to create production tools.
Mavo is a great tool for creating editable frontends for websites using different storage backends. One such storage option is Github, so that means you can use Mavo to create different frontend editors for data files you need in your repository for building purposes.
Another prototype I made (https://medium.com/@kjartanmuller/prototype-story-mapping-as-activity-mapping-f50bbf9bd2c3) explored this for testing with Cucumber and Gherkin syntax, but this time I wanted to experiment with a usecase where a part of a content production process is more like a software build process, where you kind of compile the content -- like with epub. I have been working in the publishing industry for many, many years, so it was a natural usecase.
Using GitHub and Mavo as a content platform is great for OER and Open Access purposes. You have available mechanisms for versioning and collaboration, and a way to mix a stringent editorial processes with input from everyone through pull requests.
Also I wanted to experiment with how to use CSS grid to implement the common ui pattern where you have a grid width cards that expands underneath when activated.
The prototype has been implemented technically using @Mavo (https://mavo.io) and CSS Grid Layout (https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout), and the prototype aesthetics are a result of wiredjs (https://wiredjs.com/) and Architects Daughter (https://fonts.google.com/specimen/Architects+Daughter). The editor uses Markdown (https://en.wikipedia.org/wiki/Markdown). Puppeteer (https://pptr.dev/) is used for generating a pdf, and epubcheck (https://www.npmjs.com/package/epubcheck) is used for testing. Epub basics can be found at https://github.com/bmaupin/epub-samples.
The editing tool is demoed on https://kjartanm.github.io/easy-peasy-ebook/
Caveats:
- It most likely does not work on IE 11, and is not designed for small screens.
- Since this is a prototype, I haven't really tried to optimize code.
- At the moment there is no styling of the resulting epub or pdf. For epub Blitz, (https://friendsofepub.github.io/Blitz/) could be something.
- The usecase for the pdf is proofreading, and not print. For creating a print version, maybe paged.js could be of help? (https://www.pagedmedia.org/)
yarn
Change the mv-storage attribute in the body element in docs/index.html to point to your own repository. You can also set storage to 'local' for testing using local storage as storage.
For local testing, cd to docs and use http-server.
To make it available for others, set up your repository to use GitHub pages with docs as directory.
When editing, every save will create a new commit. To build a new version of the epub you have to fetch the last data from GitHub and then use yarn build to start the process. This can be automated, and I have tested this using Now (https://zeit.co/). But epubcheck wasn't that easy to deploy.
You can use Export to look at the structure while editing.
The build process creates an epub and a pdf that is available from docs. An epubcheck report is saved to reports directory.