GithubHelp home page GithubHelp logo

hfarazm / epub-embed Goto Github PK

View Code? Open in Web Editor NEW

This project forked from hwdsb/epub-embed

0.0 2.0 0.0 1.52 MB

A WordPress plugin to easily embed eBooks published in the ePub format into your blog posts.

PHP 43.77% CSS 16.91% JavaScript 18.11% HTML 21.21%

epub-embed's Introduction

ePub Embed

ePub Embed is a WordPress plugin, allowing you to upload and embed eBooks in the ePub format into your blog posts.

Recommended: Install the Shortcake plugin to get instant ePub previews in the WordPress editor.

This plugin was developed for the Hamilton-Wentworth District School Board Commons. Licensed under the GPLv2 or later.


How to Use

  1. Activate the plugin.
  2. Create or edit a post. Click on the "Add Media" button.
  3. Upload an ePub file and click on the "Insert to Post" button.
  4. If you installed the Shortcake plugin, you'll see the ePub in the post editor. If not, you'll see an [epub] shortcode. To customize the shortcode, view the "Shortcode parameters" section below.

Shortcode parameters

The following are some custom parameters you can use with the shortcode:

  • "width" - By default, this tries to use your theme's content width. If this doesn't exist, the width is "100%". Fill in this value to enter a custom width.

  • "height" - Enter in a custom height for your ePub file if desired. Defaults to "700". Avoid percentages.

  • "downloadlink" - By default, shows a download link after the ePub viewer. Set to "false" to disable this.

Notes

  • If your WordPress media files are uploaded to the cloud, you'll need to ensure that you configure your bucket to handle CORS correctly.
  • Embedding ePub files with rich media is not 100% accurate. If you must embed ePubs with rich media, ensure that the format is supported on most browsers and ePub readers. For example, for audio, use MP3 instead of M4A.
  • Try to keep the size of the ePub as low as possible, since the entire ePub must be downloaded for processing and embedding.

Thanks

epub-embed's People

Contributors

r-a-y avatar

Watchers

James Cloos avatar Hafiz Faraz Mukhtar 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.