sija/crystal-dash-docset

Dash docset generator for Crystal

Crystal Docset

Dash docset documentation generator for the Crystal Language.

Download

Download the latest version from the releases page.

Generate the Docset

NOTE: You'll need wget and dashing utilities installed (you can use brew bundle to install those).

1. Run CRYSTAL_VERSION=<like 1.0.0> ./download.sh to download the API docs
2. Run ./build.sh
3. Enjoy your newly bundled Crystal.docset 🎉

Authors

• Chris F. Ravenscroft
• Sijawusz Pur Rahnama

crystal-dash-docset's Issues

Use the /docs from the Crystal releases instead of crawling the website

Every Crystal release contains a crystal-XXX-docs.tar.gz file which can be used instead of costly crawling the crystal-lang.org website.

Add download script?

I just used this repo to submit a PR to update the crystal docs to 0.35.1, thanks!

What do you think about including code to download the website - I don't own SiteSucker, so I used this wget script:

wget \
  --recursive \
  --no-clobber \
  --page-requisites \
  --html-extension \
  --convert-links \
  --domains crystal-lang.org \
  --no-host-directories \
  --no-parent \
  crystal-lang.org/reference/, crystal-lang.org/api/

Perhaps it could be included as ./download.sh if you don't want to include it in ./build.sh