Skip to content
Dash docset generator for Crystal
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE
README.md
build.sh
dashing.json
icon.png
icon@2x.png

README.md

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/docs/
      (SiteSucker will also pull in /api/... if you don't do it yourself)
    • Move just captured doc 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

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.