Λrrow-docset

Why should you use it?

• Λrrow-docset is faster and more intuitiv than surfing through the internet
• Λrrow-docset gives you an Single Point of Reference for everything related to the Λrrow Documentation, including the whole API Doc's, which you previously had to manuelly search through with IntelliJ

Prerequsite:

• Dash for macOS or iOS or any other .docset Browser, e.g. Zeal for Linux and Windows , Velocity for Windows and a Web version

• (Very much recommended - still optional) Dash Alfredo Workflow with Alfredo

• Powerusers should add the IntellijDash Plugin for an even smoother workflow

Install Λrrow-Docset

• Download the current docset

• Open Dash -> click the plus icon -> click Download Docsets -> click Main Docsets

• Under the Thread: Docsets -> click the plus icon in the left-hand corner -> click Add Local Docs -> specify the arrow-kt.docset file

Dash a powerful time saver

• Enjoy Λrrow Offline

• Quick-search through the whole library without breaking a sweat - thanks to Alfredo and auto-rendering

• Search with tags and filters

Features

• Enable arrow-playground
• Searchable type classes and classes
• Searchable functions
• Searchable packages
• Searchable guides
• Searchable types
• Available through the dash contribution platform

Contributions

This beautiful library deserves a dash-docset. Help me to create a more discoverable version.

To enable more features we will use dashing It is pretty straight-forward, we map Dash Datatypes to Arrow.

PR's are very welcomed ! Visit the dashing website to get started.

Your development environment is the next.arrow-kt.io file. Add the appropriate mappings to dashing.json under selector and check-out the issues.

Dowload dashing:

$ brew install dashing

or

$ go get -u github.com/technosophos/dashing

Here are the sources

## Available Docset Datatypes

Annotation  Attribute   Binding     Builtin     Callback    Category
    
Class   Command     Component   Constant    Constructor   Define   
 
Delegate   Diagram     Directive       Element     Entry       Enum 

Environment     Error       Event       Exception       Extension  

Field       File        Filter      Framework       Function     

Global      Guide       Hook        Instance        Instruction     

Interface       Keyword     Library     Literal     Macro       Method

Mixin       Modifier        Module      Namespace       Notation 

Object      Operator        Option      Package     Parameter       Plugin

Procedure       Property        Protocol        Provider     Provisioner

Query       Record      Resource        Sample      Section     Service  
   
Setting     Shortcut        Statement       Struct      Style         Subroutine 

Tag     Test        Trait       Type        Union       Value       Variable        Word

You then specify the exact place in the HTML where Dash can find the Datatype, e.g.: "css selector": "Docset Datatype"

dashing.json
{
  //...
  "selectors": {
          "title": "Interface"
      },
      //...
}

This is a pretty good example how to specify the css selectors with this tester and an cheat-cheet

• Debugging and building the docset

$ dashing build

Acknowledgement

Many Thanks to the Λrrow Community who set up the API Doc's and Guides. Special thanks to @nomisRev and @raulraja !