Git Product home page Git Product logo

dash-ios's Introduction

Discontinued

Dash for iOS was discontinued. Please check out Dash for macOS instead.

Dash gives your iPad and iPhone instant offline access to 150+ API documentation sets.

For more information about Dash, check out https://kapeli.com/dash_ios.

Also please check out Dash for macOS.

Installation Instructions

The recommended way of installing Dash is through the App Store.

Alternatively, you can use Xcode to install Dash on your iOS device using just your Apple ID.

All you need to do is:

  1. Install Xcode
  2. Download the Dash for iOS Source Code or git clone https://github.com/Kapeli/Dash-iOS.git
  3. Open "Dash iOS.xcworkspace" in Xcode
  4. Go to Xcode's Preferences > Accounts and add your Apple ID
  5. In Xcode's sidebar select "Dash iOS" and go to General > Identity. Append a word at the end of the Bundle Identifier e.g. com.kapeli.dash.ios*.name* so it's unique. Select your Apple ID in Signing > Team
  6. Connect your iPad or iPhone using USB and select it in Xcode's Product menu > Destination
  7. Press CMD+R or Product > Run to install Dash
  8. If you install using a free (non-developer) account, make sure to rebuild Dash every 7 days, otherwise it will quit at launch when your certificate expires

Contact me if you need help.

Contribution Guidelines

I am currently only accepting pull requests that fix bugs or add/improve features. I can't allocate time to review pull requests that only refactor things or add comments.

Try to maintain the same coding style I use (e.g. curly braces on their own line). I know it's a bit different from anyone else's and you might disagree with it, but having sections of code with a different style would make things worse.

dash-ios's People

Contributors

adeelshahid avatar clementpadovani avatar dmytrie avatar flovilmart avatar insightmind avatar kapeli avatar vinayjn avatar waffleboot avatar zhongwuzw avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

dash-ios's Issues

'Apple API Reference' shows 'Error. Please reinstall the API Ref docset'

macOS Dash 4.1.2
Dash iOS on iPad and from GitHub master branch

I transferred Apple API doc files from Dash macOS but when I try to open any documentation entry (class, protocol, etc) I see message 'Error. Please reinstall the Apple API Reference docset.' The reason in DHDocsetManager.m where 'DashDocSetIsGeneratedForiOSCompatibility' flag is checked.

Condition

&& ![[[docset plist] objectForKey:@"DashDocSetIsGeneratedForiOSCompatibility"] boolValue]

returns false so I see error. I see valid info when I comment this line.

Is it possible to download Apple docs directly?

The process of generating doc using Dash on macOS and then transferring to iOS devices using iTunes is tedious and time consuming.

I remember it can be done in the App Store version before it is removed from the App Store. So why it cannot be done now?

Alphabetical sort order is case sensitive

Sorting by alphabetical order is case sensitive, it lists all Docsets that begin with Caps first and then Docsets that begin with lowercase letters. For example jQuery is after YAML.

"Error: Unknown error encountered while generating HTML."

I get this error on the latest app store version. I tried downloading the docsets by airdrop, itunes and ifunbox. I tried having the mac version generate the docset and I tried it without the docset generating. I only get the error on some entries. For instance "Collection" protocol and "Comparable" protocol. These seem to be in the Swift standard library documentation. Anyone else seeing this?

Swift port

I don't think that Dash became open source just so people can take a look at the code. I believe we can work together and bring new things to this amazing app a lot of people use.

One of the things that would open even more for the community to contribute would be a Swift port since we already have a large number of people who started iOS development in Swift and don't have enough knowledge in Objective-C to contribute.

By porting to Swift we're also making sure this code is ready for future features since a lot of new open source libraries are written in Swift, as well as specific Swift features that could reduce the complexity of the code.

Of course, this idea is kinda crazy because of the complexity of the whole project and the amount of code written here, but if we organize a team, I believe this can happen.

Any thoughts? 🤔

Page not found

Hi, I use Dash for read ''Apple_API_Reference'', after I follow the prompts, I had transfer the .docset file to my iPhone, But When I click a className(or protocol, method...), Dash cannot load the data, the detail page shows "Page not found", my phone is iPhone6s, iOS version is 10.3.

Feature Request: Snippets

Would be great to view snippets on the iOS application, especially if you've set the snippet library location on the Mac app to your iCloud Drive.

Feature Request: Different collapsing behavior

Hi there,

I'd really appreciate if we had the ability to change the collapsing behavior of the app. I'm using Dash iOS on my iPhone 6 Plus and rotate the app to landscape to get more width and better readability in some doc sets. But as soon as I rotate back to portrait, by default, the app collapses to the master controller where a list of items is presented, however I still might want to read my currently selected item. 😉

Thank you for building such a handy app.

Is it possible to compile Dash-iOS for iOS 7.1.2?

I tried to compile on Xcode 8.0 with manually added 7.1 iPhoneOS platform. It compiles with this warning:
ld: warning: object file (~/Library/Developer/Xcode/DerivedData/Dash_iOS-quiemwexbwwcvhvpnwbvzmgqlnpr/Build/Products/Debug-iphoneos/libPods-Dash.a(Pods-Dash-dummy.o)) was built for newer iOS version (9.0) than being linked (7.1)
I changed this line in Podfile:
platform :ios, "7.1"
and IPHONEOS_DEPLOYMENT_TARGET in Pods project; but no luck.
The code compiles and runs on my iPhone 4, but its screen freezes in the first screen and there are no reactions.
Is it possible to configure the project to be compiled for iOS 7.1.2?

Some issues about the iOS API

I also downloaded the file with type of ".docset" .And transporting into my iPhone following your offered method. However there is nothing when I open the "Apple API Reference".So that's why?

Feature Request: Keyboard navigation on iOS

Dash is great on iOS, especially when the iPad is acting as a secondary computer.

The iPad Pro + Keyboard provides a great workflow to do some auxiliary tasks, and even some development work. I really wish Dash for iOS supported more keyboard command similar to Dash for Mac.

  • Filtering by a specific docset using [docset]:
  • Navigating between search results with arrow keys
  • Activating a search within the activated docset with a key combination.

Thanks in advance.

Release w/ bundle

Would be good if releases could actually include the mac app bundle each time, so it's even easier to install, specially to update. Thanks for open sourcing!

Apple API Reference can't be transferred

Transferring with iTunes is completely broken. Tried with iMazing, the same, transfer speed is 0.01 MB/s
For a 2.46GB file size this is unusable.
Other means of transfer is absolutely needed otherwise the app is useless.
-> Import the file via Files app which can see the docset from iCloud or Dropbox or whatever.

Other solution upload to the app via a localhost web server like in many other apps.

I don't know but...this limitation in iTunes for transfering big files is ridiculous.

Docset alphabetizing

It would be really nice to have a setting that allows me to have the doc sets alphabetized on the main iOS screen.

Impossible to add iOS device as a remote in Dash for Mac

Hi there,

When I try to add a new iOS remote in Dash for Mac the pairing process starts but no inputs are shown in the iOS app to continue the process. Seems like it doesn't even recognize my Mac trying to pair with it, could it be a code signing problem?

Build Failed for v1.6.0, Xcode 8.2

While following the installation instructions using either the master branch, or 1.6.0 tag, building the workspace shows some build errors. Building the main Dash project in the workspace directly to an iPhone 6s shows a link error. Each dependency builds correctly though. libPods-Dash builds correctly, but think the actual output folder doesn't match where the project is looking for it.

As a workaround, had to copy the output from Dash-iOS/build/Debug-iphoneos to Dash-iOS/Dash/build/Debug-iphoneos. Then it builds/runs fine. Couldn't figure out how to fix the project or podfile setup.

/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/Dash.app/Dash
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/AutoCoding'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/DTBonjour'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/DZNEmptyDataSet'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/GZIP'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/JGMethodSwizzler'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/KissXML'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/MRProgress'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/NSTimer-Blocks'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/Reachability'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/SAMKeychain'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/UIActionSheet+Blocks'
ld: warning: directory not found for option '-L/Users/XYZ/Projects/Dash-iOS/Dash/build/Debug-iphoneos/UIAlertView+Blocks'
ld: library not found for -lAutoCoding
clang: error: linker command failed with exit code 1 (use -v to see invocation)

Unable to AirDrop docset

When using AirDrop to send a docset.

Dash isn’t recognized as being able to handle docsets, thus iOS is offering the option to save the file to iCloud Drive or to search an app on the App Store.

screenshot

ios 11 docset import

I cannot add new custom docsets without using iTunes file transfer. ios does not appear to know what to do with docsets when they show up on the device.

I just get a window that says “lwjgl Docset File Type Handler”

Thanks!

This must have been a hard decision for you given everything that's happened.

Thank you for giving it to the community

Instructions in README result in Debug build of app

Following the readme instructions (and instructions on kapeli.com) results in a non-optimized, debug build of Dash for iOS. This isn't terrible, and anyone familiar with Xcode can fix it, but I think it'd be nice to improve the situation for everyone else.

I can think of two easy ways to solve this, and I'm not sure which you'd prefer. Obviously, the instructions could be edited to add step 6.5: change the build configuration.

It might be even better to check in a shared scheme that uses the Release configuration for the Run action. This has the potential to confuse existing users with the repo checked out (when they suddenly have two schemes: the autogenerated one and the shared one), and it introduces friction for anyone hacking on the codebase who expects the Run action to use the Debug config. I think those are reasonable tradeoffs to keep the instructions simpler for everyone else, but it's not obvious to me which is the right choice.

Thanks!

Crashes on open after using as remote

As far as I can tell, coming back to Dash-iOS after having paired it and then severed the pairing makes it crash the next time you open it. Had to reinstall on my iPad to get it back to working condition. Any ideas?

iPad Pro, 10.2

Update notification

It would be amazing to implement async check GitHub for new releases every time the app is opened.

Bug: Can't Delete Swift Docset

Since Swift docset is removed, the settings page for the Swift docset displays the download button. Users previously downloaded Swift docset can no longer delete it.

Font Resizing Controls do not work on iPad(s)

It seems that Font Resize controls do not work on any iPad (Mini, Air2, Pro). iPhone 6 Plus? Fine.

  1. Open a docset or cheatsheet
  2. Try the Font Size Controls

RESULT: Controls show as being invoked/called in XCode Console, but no effect in UI. No change in font size at all.

REGRESS: Try above steps with iPhone. Works as expected.

Bug: Persistent Docsets Disappearing

Expected Behavior: docsets will download and persist between app restarts

Observed Behavior: docsets download and can be accessed, but when the app is terminated and restarted they disappear.

Steps to reproduce:

  1. install a docset

  2. terminate the application

  3. restart the app

  4. observe the docset list showing as empty

(Jump to) Main Page Control missing on iPad(s)

PROBLEM: The main page '>' control that appears at the top of every docset is missing when Dash-iOS is run on an iPad.

  1. Grab current Dash (12/3/2016, post 1.6 build) and sideload.
  2. Run on iPhone. Open Bash (or other docset). Note "Bash >" that allows jump to main page.
  3. Run on iPad. Open Bash (or other docset). Note "Bash" but not jump control to or back to main page. If you "drill in" there's no control.

EXPECT: Same control as iPhone, whether in landscape or (as I run on my iPads) portrait. I'm 100% in portrait mode most of the time.

Bug found

Immediately after downloading a doc, if you hit done the app crashes

Apple API Reference can't read

Just open this document will show "load?request_key=xxxxxxxxxx"
None of this problem appears in other documents
And it's no problem at the beginning

Crash on launch

Hey,

Per your latest update, I'm getting a constant crash at launch (update and clean install).

Attached are the crash logs.

Configuration: iPhone X running iOS 11.2.1

(Compressed the .crash logs to please GitHub)
Archive.zip

Remember previous page's position

When I click the back button on toolbar, I found that the previous page is not at the origin position, it seems reloaded and return to the top of the page, I think it's better to remember current page's position when the page is pushed to next page.

Can see iPad Dash, but "Pair Remote" from OS X does nothing?

OS X 10.12.2, Dash 3.4.2, Dash iOS 1.6.0.

Dunno if this may be a code-signing problem or something else. Just got the 1.6.0 iOS version installed. Anything I can try to debug the issue? Is this a defunct feature now that the iOS client is open sourced? Just seems like a cool feature is all.

Cannot connect to Dash iOS over WiFi

on v1.6.2 on iPhone and iPad, been getting

Could not send pair request. Error message:
Could not open connection. Try again.

while trying to connect to iOS from Mac.

Tried reinstalling both iOS and MacOS version, but cannot get remote to connect anymore.

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.