Giter VIP home page Giter VIP logo

docset2ebook's Introduction

docset2kindle

This is a Python script to convert Apple’s developer documentation to the Kindle’s mobipocket format, including table of contents and chapter markers.

Requirements:

  • The kindlegen commandline tool has to be downloaded separately from Amazon.
  • Docsets can be downloaded with Xcode. The Mac OS X documentation set is typically located in /Developer/Documentation/DocSets, e.g. /Developer/Documentation/DocSets/com.apple.adc.documentation.AppleSnowLeopard.CoreReference.docset. The iOS documentation is usually in /Library/Developer/Documentation/DocSets.

Usage:

  • Place the kindlegen binary in the script’s directory or somewhere in your $PATH.
  • > python docset2kindle.py "path/to/docset" -o output_directory
  • This will extract all documents of type ‘Guide’ or ‘Getting Started’ from the specified docset and put Kindle versions in the output directory (documentation for individual classes etc. is not included). The conversion may take a couple of minutes. The docset for iOS contains about 140 books, the one for Mac OS X about 340.
  • > python docset2kindle.py "path/to/docset" -o output_directory -f epub
  • This will convert all document to EPUB format.
  • It’s also possible to specify a directory that contains multiple docsets (e.g. /Developer/Documentation/DocSets), but as the output file names are determined by the book titles, it is possible that a book in one of the docsets overwrites a book with the same title in another docset.

Known Issues:

  • Lists (ul, ol) don’t look quite right (there’s too much vertical space after the bullet point)
  • Links across books don’t work (I’m not sure if this is even possible with Kindle books)
  • Newest Apple docsets not supported. Newest supported docsets are:
  • iOS 4.3 Library
  • Snow Leopard Library (install from XCode)

docset2ebook's People

Watchers

 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.