Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Sija/crystal-dash-docset
Dash docset generator for Crystal
https://github.com/Sija/crystal-dash-docset
crystal dash dash-docset docset documentation
Last synced: about 2 months ago
JSON representation
Dash docset generator for Crystal
- Host: GitHub
- URL: https://github.com/Sija/crystal-dash-docset
- Owner: Sija
- License: mit
- Created: 2017-04-23T12:11:53.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-13T17:17:27.000Z (6 months ago)
- Last Synced: 2024-02-01T16:08:14.020Z (5 months ago)
- Topics: crystal, dash, dash-docset, docset, documentation
- Language: Shell
- Homepage:
- Size: 15.6 KB
- Stars: 16
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-crystal - crystal-dash-docset - [Dash](https://kapeli.com/dash) docset generator (Official Documentation Translations)
- awesome-crystal - crystal-dash-docset - [Dash](https://kapeli.com/dash) docset generator (Official Documentation Translations)
- awesome-crystal - crystal-dash-docset - [Dash](https://kapeli.com/dash) docset generator (Official Documentation Translations)
README
# Crystal Docset [](https://github.com/Sija/crystal-dash-docset/actions/workflows/dockset.yml)
[Dash](https://kapeli.com/dash) docset documentation generator for the [Crystal Language](https://crystal-lang.org/).
## Download
Download the latest version from the [releases page](https://github.com/Sija/crystal-dash-docset/releases/latest).
## Generate the Docset
**NOTE**: You'll need `wget` and [`dashing`](https://github.com/technosophos/dashing) utilities installed (you can use `brew bundle` to install those).
1. Run `CRYSTAL_VERSION= ./download.sh` to download the API docs
2. Run `./build.sh`
3. Enjoy your newly bundled `Crystal.docset` 🎉
## Authors
- [Chris F. Ravenscroft](https://github.com/fusion)
- [Sijawusz Pur Rahnama](https://github.com/Sija)