Official Documentation of Raku™
An HTML version of this documentation can be found at https://docs.raku.org/. That site is updated from the main branch here frequently (but not continuously).
This is currently the recommended way to consume the documentation. The tooling to build and run this site is available on github.
This repository is not intended to be installed as a module.
README in other languages
日本語 | 普通话 | Deutsche | español | français | italiano | nederlands | Português
Help Wanted!
Why aren't the docs embedded in the compiler source?
- This documentation is intended to be universal with respect to the specification, and not tied to any specific implementation.
- Implementations' handling of embedded Pod is still a bit uneven; this avoids potential runtime impacts.
- A separate repo in the Raku Github account invites more potential contributors and editors.
rakudoc
There is a CLI for viewing Raku documentation.
Vision
I want p6doc and docs.raku.org to become the No. 1 resource to consult when you want to know something about a Raku feature, be it from the language, or built-in types and routines. I want it to be useful to every Raku programmer.
-- moritz
LICENSE
The documentation and code in this repository is available under the Artistic License 2.0 as published by The Perl Foundation. See the LICENSE file for the full text.
This repository may also contain examples authored by third parties that may be licensed under a different license. Such files indicate the copyright and license terms at the top of the file. Currently these include:
- Examples from Stack Overflow; MIT License (ref #1 for 1f7cc4e)