https://github.com/svoop/hanami-docset
Dash docset for Hanami
https://github.com/svoop/hanami-docset
Last synced: 10 months 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 (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-09T14:43:13.000Z (over 1 year ago)
- Last Synced: 2025-02-09T15:33:43.369Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 2
- 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.
## References
* [Dashing](https://github.com/technosophos/dashing)