https://github.com/yesmeck/hexdocset

Convert hex doc to Dash.app's docset format.
https://github.com/yesmeck/hexdocset

Last synced: 8 days ago
JSON representation

Convert hex doc to Dash.app's docset format.

• Host: GitHub
• URL: https://github.com/yesmeck/hexdocset
• Owner: yesmeck
• Created: 2014-12-30T09:02:49.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-26T12:11:25.000Z (almost 9 years ago)
• Last Synced: 2024-10-01T10:38:45.091Z (about 1 month ago)
• Language: Elixir
• Homepage:
• Size: 10.7 KB
• Stars: 22
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Convert hex doc to Dash.app's docset format. (Documentation)
• fucking-awesome-elixir - hexdocset - Convert hex doc to Dash.app's docset format. (Documentation)
• awesome-elixir - hexdocset - Convert hex doc to Dash.app's docset format. (Documentation)

README

        
# Hexdocset

**[Dash support hexdoc officially now!](https://kapeli.com/docsets#exdoc)**

Convert hex doc to Dash.app's docset format.

## Installation

### Requirements

- sqlite3

### Direct download

Download the binary release from the [release page](https://github.com/yesmeck/hexdocset/releases).

### Build from source

```bash

git clone https://github.com/yesmeck/hexdocset.git && cd hexdocset && mix do deps.get, escript.build

```

## Usage

```bash

hexdocset   

```

### Example

Convert Phoenix's doc

```bash

hexdocset Phoenix ./phoenix_docs .

```