https://github.com/svoop/hanami-docset

Dash docset for Hanami
https://github.com/svoop/hanami-docset

Last synced: 7 days ago
JSON representation

Dash docset for Hanami

• Host: GitHub
• URL: https://github.com/svoop/hanami-docset
• Owner: svoop
• License: mit
• Created: 2024-03-03T16:10:06.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-03-04T11:56:55.000Z (8 months ago)
• Last Synced: 2024-03-04T17:31:53.528Z (8 months ago)
• Language: Ruby
• Homepage:
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Hanami Dash Docset

This docset for [Dash](https://kapeli.com/dash) contains the developer guides of [Hanami](https://hanamirb.org/), a modern web framework for Ruby.

## Download

No releases yet, there's still too much room for improvements. However, you can download the `hanami-*.docset` artefact of the [latest successful workflow run](https://github.com/svoop/hanami-docset/actions).

## Development

For this to work, both [Homebrew](https://brew.sh/) and [Ruby](https://www.ruby-lang.org/en/) have to be installed.

```bash

# Install tools

brew install dashing hugo

# Build

./build.sh

# Install

open hanami.docset

```

## Action

The workflow reads the version to build the docset for from `version.txt`. The leading `v` has to be omitted.