The C<rakudoc> command displays Raku documentation for language features
and installed modules.

head

rakudoc - A tool for reading Raku documentation


<query> Example: 'Map', 'IO::Path.add', '.add'
 -d|--doc-sources=<Directories> Additional directories to search for documentation
 -D|--no-default-docs Use only directories in --doc / $RAKUDOC
 -b|--build-index Index all documents found in doc source directories

SYNOPSIS

DESCRIPTION

ENVIRONMENT

It is free software; you can redistribute it and/or modify it under the
terms of the
L<Artistic License 2.0|https://www.perlfoundation.org/artistic-license-20.html>.

LICENSE

root

para

L<Examples| file:../examples/index.podlite>

L<Download |file:../download/index.podlite>

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React

HEADER

FOOTER

rakudoc

Html

=begin Html
<img style="float: right; margin: 0 0 1em 1em; width:261px" src="/images/Camelia.svg" alt="" id="home_logo"/>
Welcome to the official documentation of the <a href="https://raku.org">Raku</a>
programming language!
Besides online browsing and searching, you can also
<a href="/perl6.html">view everything in one file</a> or
<a href="https://github.com/Raku/doc">contribute</a>
by reporting issues or sending patches.

<hr/>

<dl>

<dt><a href="/language.html">Language Reference &amp; Tutorials</a></dt>
<dd>
 A collection of documents describing, in detail, the various
 conceptual parts of the language.


</dd>

<dt><a href="/type.html">Type Reference</a></dt>
<dd>
 Index of built-in classes, roles and enums.
</dd>

<dt><a href="/routine.html">Routine Reference</a></dt>
<dd>
 Index of built-in subroutines and methods.
</dd>

<dt><a href="/programs.html">Raku Programs</a></dt>
<dd>
 A collection of documents describing the variables that affect the the Raku executable, how to run the p6doc documentation front-end,
 how to debug Raku programs, and how to hack on Raku
 source code.
</dd>

<dt><a href="/language/faq">FAQs (Frequently Asked Questions)</a></dt>
<dd>
 A collection of questions that have cropped up often, along with answers.
</dd>
<dt><a href="/language/community">Community</a></dt>
<dd>
 Information about the Raku development community, email lists, IRC and IRC bots, and blogs
</dd>
<hr/>


The Raku homepage offers <a href="https://raku.org/resources/">a
comprehensive list of Raku resources</a>, including tutorials, and how-tos.

You may be interested in the <a href="https://raku.org/community/">Community</a> page on the
main Raku website.


Raku compiler developers may also be interested in
<a href="https://github.com/perl6/roast">The Raku Specification</a>.


Part of this official documentation has been translated into Chinese. Here's the <a href='https://github.com/ohmycloud/perl6doc-zh/blob/master/index.adoc'>index to the pages that have been translated</a>.

=end Html

# vim: expandtab softtabstop=4 shiftwidth=4 ft=perl6


Image

code

item

README

The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer> 
=begin nested :!nested
=item1 B<Language>
 =item2 L<Get started|file:../getting-started/getting-started.podlite>
 =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
 =item2 L<Try Raku|https://glot.io/new/raku>
 =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
 =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
 =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
 =item2 L<Language References|file:../doc/reference.podlite>
 =item2 L<Type Reference| file:../doc/types.podlite>
 =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
 =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
 =item2 L<Community|/doc/language/community>
 =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
 =item2 L<The Raku Guide|https://raku.guide/>
 =item2 L<Books |https://perl6book.com/>
 =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
 =item2 L<Download | file:../download/index.podlite>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<empty|#>

=item1 B<Learning>
 =item2 L<The Raku Guide|https://raku.guide/>
 =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
 =item2 L<Books |https://perl6book.com/>
 =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
 =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
 =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
 =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
 =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
 =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
 =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<empty|#>
 =item2 L<empty|#>

=end nested
=end React

=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React

rakudoc

NAME

SYNOPSIS

ENVIRONMENT

LICENSE

rakudoc v0.2.5

Authors

License

Dependencies

Test Dependencies

Provides

Documentation