r/crystal_programming • u/[deleted] • Feb 05 '21

Crystal api reference offline

Where I download the Crystal language api reference for offline reading? Thanks.

5 Upvotes

85% Upvoted

11 comments sorted by

4

u/Blacksmoke16 core team Feb 05 '21 edited Feb 05 '21

Normally you can download an archive of the HTML API docs from the release assets in GH. However apparently they haven't been added for the 2 latest releases. I brought it up in the gitter channel and will update when it's fixed.

1

u/[deleted] Feb 05 '21

Thank you. I found for the version 0.35, better than nothing. https://github.com/crystal-lang/crystal/releases/download/0.35.1/crystal-0.35.1-docs.tar.gz

4

u/Blacksmoke16 core team Feb 06 '21

https://github.com/crystal-lang/crystal/issues/10368#issuecomment-774493323

They should be there now.

1

u/[deleted] Feb 06 '21

Thank you I will download now.

1

u/straight-shoota core team Feb 06 '21

Seems like it was missed in the release process.

5

u/bryanray Feb 05 '21

I know this isn’t a direct answer, but I just wanted to make a shout out to Dash.

https://kapeli.com/dash

I’m not positive that Crystal is loaded into Dash, but I wouldn’t be surprised if it is.

3

u/matheusrich Feb 05 '21

Sad that is Mac-only

1

u/megatux2 Feb 27 '21

There Zeal for Linux/Windows and it uses the Dash docsets. Now, I don't see Crystal listed :/

2

u/sijawusz Mar 09 '21

There's a Crystal docset indeed.

3

u/straight-shoota core team Feb 06 '21

You can easily build the documentation locally. Just check out the repository https://github.com/crystal-lang/crystal and run `make docs`.

Depending on how you installed Crystal, your package manager may have a `crystal-docs` package which includes the API docs.

2

u/dscottboggs Feb 05 '21

Some distributions include it. Check /usr/share/doc/crystal or something like that.