{"id":17249068,"url":"https://github.com/i-walker/arrow-docset","last_synced_at":"2025-02-24T18:31:10.362Z","repository":{"id":38400774,"uuid":"182033205","full_name":"i-walker/arrow-docset","owner":"i-walker","description":"A Dash-docset for Λrrow","archived":true,"fork":false,"pushed_at":"2023-12-17T08:11:30.000Z","size":104856,"stargazers_count":6,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-12T14:18:39.468Z","etag":null,"topics":["arrow-kt","category-theory","dash","dash-docset","functional","functional-programming","kotlin","kotlin-library","monads"],"latest_commit_sha":null,"homepage":"https://github.com/arrow-kt/arrow","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/i-walker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-18T06:55:28.000Z","updated_at":"2024-07-23T12:53:56.000Z","dependencies_parsed_at":"2022-08-18T13:21:24.435Z","dependency_job_id":null,"html_url":"https://github.com/i-walker/arrow-docset","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i-walker%2Farrow-docset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i-walker%2Farrow-docset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i-walker%2Farrow-docset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i-walker%2Farrow-docset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/i-walker","download_url":"https://codeload.github.com/i-walker/arrow-docset/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240535226,"owners_count":19817029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arrow-kt","category-theory","dash","dash-docset","functional","functional-programming","kotlin","kotlin-library","monads"],"created_at":"2024-10-15T06:42:46.617Z","updated_at":"2025-02-24T18:31:05.354Z","avatar_url":"https://github.com/i-walker.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"## [Λrrow](https://next.arrow-kt.io/docs/)-docset\n\u003cimg height=\"70\" src=\"https://avatars2.githubusercontent.com/u/29458023?v=4\u0026amp;s=200\" width=\"70\"\u003e\n\n### Why should you use it?\n- *Λrrow-docset* is **faster** and **more intuitiv** than surfing through the internet\n- *Λ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\n\n![Worlflow](Apr-22-2019%2011-04-23.gif)\n\n#### Prerequsite:\n- [Dash for macOS or iOS ](https://kapeli.com/dash) or any other .docset Browser, e.g. [Zeal for Linux and Windows ](https://zealdocs.org), [Velocity for Windows ](https://velocity.silverlakesoftware.com) and a [Web version](https://devdocs.io)\n\n- (Very much recommended - still optional) [Dash Alfredo Workflow](https://github.com/Kapeli/Dash-Alfred-Workflow) with [Alfredo](https://www.alfredapp.com)\n\n- Powerusers should add the [IntellijDash Plugin](https://github.com/gdelmas/IntelliJDashPlugin) for an even smoother workflow \n\n### Install Λrrow-Docset\n\n- Download the [current docset](https://github.com/i-walker/Arrow-Docset/releases)\n- Open [Dash](https://kapeli.com/dash) -\u003e click the plus icon -\u003e click Download Docsets -\u003e click Main Docsets \n\n- Under the Thread: Docsets -\u003e click the plus icon in the left-hand corner -\u003e click Add Local Docs -\u003e specify the arrow-kt.docset file\n\n### Dash a powerful time saver\n- Enjoy Λrrow Offline \n![minimal](Screenshot%202019-04-22%20at%2008.23.14.png)\n\n- Quick-search through the whole library without breaking a sweat - thanks to [Alfredo](https://github.com/Kapeli/Dash-Alfred-Workflow) and auto-rendering \n\n![Arrow example](Screenshot%202019-04-21%20at%2021.51.02.png)\n\n- Search with tags and filters\n\n![Haskell example](Screenshot%202019-04-21%20at%2021.34.08.png)\n\n### Features\n\n- [X] Enable arrow-playground\n- [X] Searchable type classes and classes\n- [X] Searchable functions\n- [X] Searchable packages\n- [X] Searchable guides\n- [X] Searchable types \n- [ ] Available through the dash contribution platform \n\n\n## Contributions\n\nThis beautiful library deserves a dash-docset. \nHelp me to create a more discoverable version. \n\nTo enable more features we will use [dashing](https://github.com/technosophos/dashing)\nIt is pretty straight-forward, we map [Dash Datatypes](https://kapeli.com/docsets#supportedentrytypes)\nto Arrow. \n\nPR's are very welcomed ! \nVisit the [dashing website](https://github.com/technosophos/dashing) to get started.\n\nYour development environment is the [next.arrow-kt.io file](https://github.com/i-walker/Arrow-Docset/tree/master/next.arrow-kt.io). \nAdd the appropriate mappings to dashing.json under selector and check-out the issues.\n\nDowload dashing:\n```\n$ brew install dashing\n```\nor \n```\n$ go get -u github.com/technosophos/dashing\n```\nHere are the [sources](https://github.com/technosophos/dashing/releases)\n\n```\n## Available Docset Datatypes\n\nAnnotation  Attribute   Binding     Builtin     Callback    Category\n    \nClass   Command     Component   Constant    Constructor   Define   \n \nDelegate   Diagram     Directive       Element     Entry       Enum \n\nEnvironment     Error       Event       Exception       Extension  \n\nField       File        Filter      Framework       Function     \n\nGlobal      Guide       Hook        Instance        Instruction     \n\nInterface       Keyword     Library     Literal     Macro       Method\n\nMixin       Modifier        Module      Namespace       Notation \n\nObject      Operator        Option      Package     Parameter       Plugin\n\nProcedure       Property        Protocol        Provider     Provisioner\n\nQuery       Record      Resource        Sample      Section     Service  \n   \nSetting     Shortcut        Statement       Struct      Style         Subroutine \n\nTag     Test        Trait       Type        Union       Value       Variable        Word\n\n```\n\nYou then specify the exact place in the HTML where Dash can find the Datatype, e.g.:\n\"css selector\": \"Docset Datatype\"\n\n```\ndashing.json\n{\n  //...\n  \"selectors\": {\n          \"title\": \"Interface\"\n      },\n      //...\n}\n```\nThis is a pretty good [example](https://www.awesome-testing.com/2017/05/how-to-find-test-cssselector-using.html) how to specify the css selectors with this [tester](https://www.w3schools.com/cssref/trysel.asp) and an [cheat-cheet](https://www.w3schools.com/cssref/css_selectors.asp)\n- Debugging and building the docset\n\n```bash\n$ dashing build\n```\n\n## Acknowledgement\nMany Thanks to the Λrrow Community who set up the API Doc's and Guides. Special thanks to [@nomisRev](https://github.com/nomisRev) and [@raulraja](https://github.com/raulraja) !","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fi-walker%2Farrow-docset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fi-walker%2Farrow-docset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fi-walker%2Farrow-docset/lists"}