The Crystal Programming Language
Clone or download
MakeNowJust and RX14 Generate toplevel docs correctly (#7063)
Fixed #6637

Until now `crystal docs` needs to define public toplevel method for
generating `toplevel.html`. It seems a bug.

By this fix, `toplevel.html` is generated only if public toplevel constant,
method or macro is defined under your project.
I think it is proper behavior.
Latest commit 2d4e955 Nov 13, 2018


Travis CI Build Status CircleCI Build Status Join the chat at Bountysource Code Triagers Badge


Crystal is a programming language with the following goals:

  • Have a syntax similar to Ruby (but compatibility with it is not a goal)
  • Statically type-checked but without having to specify the type of variables or method arguments.
  • Be able to call C code by writing bindings to it in Crystal.
  • Have compile-time evaluation and generation of code, to avoid boilerplate code.
  • Compile to efficient native code.


We love Ruby's efficiency for writing code.

We love C's efficiency for running code.

We want the best of both worlds.

We want the compiler to understand what we mean without having to specify types everywhere.

We want full OOP.

Oh, and we don't want to write C code to make the code run faster.

Project Status

Crystal is still under heavy development. There can be breaking changes but we're trying to keep them as minimum as possible.

The development is possible thanks to the community's effort, 84codes' support, and every BountySource supporter.


Follow these instructions

Try it online



Questions or suggestions? Ask in our Google Group, join our IRC channel #crystal-lang at, ask on our Gitter channel or ask on Stack Overflow under the crystal-lang tag.


Read the general Contributing guide, and then:

  1. Fork it (
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request