Skip to content

paulkoegel/redux-offline-docs

Repository files navigation

Direct Download Links


For advanced users: create your own PDF, ePub, or MOBI versions of the Redux documentation for offline reading
  • install Calibre

  • add it to your path:

    $ ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin
    
  • install gitbook using npm:

    $ npm install gitbook-cli -g
    
  • clone the Redux repository to somewhere like ~/repositories/redux:

    git clone [email protected]:reduxjs/redux.git ~/repositories/redux
    
  • then EITHER use the create-docs script from this repository by following these steps:

    • clone this repository to ~/repositories/redux-offline-docs:

      $ git clone [email protected]:paulkoegel/redux-offline-docs.git ~/repositories/redux-offline-docs
      
    • cp ~/repositories/redux-offline-docs/create-docs ~/repositories/redux

    • cd ~/repositories/redux/ && ./create-docs

    • the script assumes that the redux and redux-offline-docs folders are siblings. You'll need to adjust the path in create-docs if you have other folder locations.

  • OR run the following commands in ~/repositories/redux:

    $ gitbook pdf . docs/redux-documentation.pdf
    $ gitbook epub . docs/redux-documentation.epub
    $ gitbook mobi . docs/redux-documentation.mobi