/crystal-dash-docset

Dash docset generator for Crystal

Primary LanguageShellMIT LicenseMIT

Crystal Docset

Dash docset documentation generator for the Crystal Language.

How to generate the docset

NOTE: You'll need dashing utility installed within $PATH.

  1. Run a site capture such as SiteSucker or a glorious curl command
    • Capture everything under https://crystal-lang.org/reference/
      (SiteSucker will also pull in /api/... if you don't do it yourself)
    • Move just captured reference and api directories into this folder
  2. Edit the TARGET variable in build.sh to point to your forked Kapeli docset repository (or use TARGET env variable)
  3. Then run ./build.sh

Authors