Code Monkey home page Code Monkey logo

vim-epub's Introduction

vim-epub

A Vim plugin for EPUB edition. Released under GNU GPL 3 (check LICENSE file).

With Vim, you can already edit an epub file and modify it's content, and save, and so on.

But the EPUB file is read-only: you can't add files and do many other things.

vim-epub is here to make you free of stupid tasks like extracting the EPUB, add the file you want to add, recompress in 2-steps the EPUB, re-open Vim.

Installation

Supported operating systems

Unices

  • BSDs
  • Mac OS
  • GNU/Linux distributions

And Windows?

Short version: Vim-EPUB can’t work under Microsoft Windows.

Long version: See here.

Vim

You need a copy of Vim compiled with python support.

Needed programs

You need the unzip programm in order to make zip.vim (built-in) work. It is frequently installed by default on newbies distributions like Ubuntu, Linux Mint…

In Debian-like GNU/Linux distributions:

sudo apt-get install unzip

You also needs pandoc programm.

Again:

sudo apt-get install pandoc

Plugin managers

  • Add Bundle 'etnadji/vim-epub' or Bundle 'https://github.com/etnadji/vim-epub' to .vimrc
  • Run :BundleInstall
  • git clone https://github.com/etnadji/vim-epub ~/.vim/bundle/vim-epub
  • Add NeoBundle 'https://github.com/etnadji/vim-epub' to .vimrc
  • Run :NeoBundleInstall
  • Add Plug 'https://github.com/etnadji/vim-epub' to .vimrc
  • Run :PlugInstall

Notable features

  • Adding medias (XHTML, CSS, fonts, images…)
  • Add a Table of contents page.
  • Provide a menu to easily link XHTML and CSS contents.
  • Merge, rename files embedded in the EPUB
  • Check the differences between the current EPUB and another.

And more:

The full list of features / commands is available on the wiki or doc files (en /fr): :help vim-epub.txt or :help vim-epub-french.txt

Contribute!

See TODO.md.

vim-epub's People

Contributors

etnadji avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  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.