Documentation for every Crystal shard

Generated API documentation for every published shard, served straight from the source repository.

Packages
6,005
Built versions
4,794

Using CrystalDocs

Pin a version

The version in the path is the version you read. Omit it and you follow the current release.

https://crystaldocs.org/docs/kemal/1.6.0

Link a type or method

Types are files below the version, and namespaces nest. Methods are anchors on the type page, like #size-instance-method.

https://crystaldocs.org/docs/kemal/1.6.0/Kemal/Config.html

Publish your docs

Tag a release on the repository and the builder picks it up. There is nothing to upload.

git tag -a v1.0.0 -m "Release v1.0.0"
git push --tags

Recently Updated

Doubles (stubs and mocks) library for Crystal, inspired by the API of rspec-mocks

Not built yet

Popular Packages

crystal

1.21.0

The Crystal standard library

4739 views

Doubles (stubs and mocks) library for Crystal, inspired by the API of rspec-mocks

Not built yet