Skip to content

Commit 7759a30

Browse files
committed
about.pod6
1 parent ca19bc5 commit 7759a30

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

doc/Language/about.pod6

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
=TITLE About the Docs
44
5-
=SUBTITLE Documentation for the Perl 6 Documentation Project
5+
=SUBTITLE Meta-documentation
66
77
This document collection represents the on-going effort to document the Perl 6 programming
88
language with the goals of being: comprehensive; easy to use; easy to
@@ -17,19 +17,19 @@ GitHub|https://github.com/perl6/doc>.
1717
1818
This particular document is a quick overview of the process
1919
described in more detail in L<CONTRIBUTING on GitHub|https://github.com/perl6/doc/blob/master/CONTRIBUTING.md>.
20-
This document also provides a short introduction to writing the Perl 6
21-
POD files, which can be rendered into HTML and other formats.
20+
This document also provides a short introduction to writing Perl 6
21+
Pod files, which can be rendered into HTML and other formats.
2222
2323
=head1 Structure
2424
25-
All of the documentation is written in Pod6 and kept in the C<doc/>
25+
All of the documentation is written in Perl 6 Pod and kept in the C<doc/>
2626
directory, and the C<doc/Language/> and C<doc/Type/> sub-directories.
2727
These files are processed as collections of definitions or
2828
"documentables", which are then post-processed and linked together.
2929
30-
=head1 Generating HTML from POD
30+
=head1 Generating HTML from Pod
3131
32-
To generate HTML from the POD files, you'll need:
32+
To generate HTML from the Pod files, you'll need:
3333
3434
=item A recent version of the Rakudo Perl 6 compiler
3535
@@ -39,7 +39,7 @@ To generate HTML from the POD files, you'll need:
3939
=item B<Optional>: L<GraphViz|http://graphviz.org>, for creating graphs
4040
of the relationships between Perl 6 types
4141
42-
=item B<Optional>: L<Pygments|http://pygments.org>, for doing syntax
42+
=item B<Optional>: L<Atom Highlights|https://github.com/atom/highlights> and L<language-perl6|https://atom.io/packages/language-perl6>, for syntax
4343
highlighting
4444
4545
To generate the documentation into the C<html/> folder, run:
@@ -57,6 +57,12 @@ perl app.pl daemon
5757
5858
=head1 Contributing
5959
60+
The documentation is written in Perl 6 Pod.
61+
62+
For a quick introduction to Perl 6 Pod, see L<Perl 6 Pod|https://docs.perl6.org/language/pod>.
63+
64+
For full details about the Perl 6 Pod specification, see L<Synopsis 26, Documentation|https://design.perl6.org/S26.html>.
65+
6066
=head2 Adding definitions
6167
6268
Documentables can be defined using an C<=headN> Pod directive, where
@@ -141,6 +147,4 @@ renders like this
141147
142148
Notice that text after a pipe ('|') has no formatting. Also note that B<V< C<> >>
143149
preserves spaces and treats text as verbatim.
144-
145-
For full details about Perl 6 POD, see L<Synopsis 26, Documentation|https://design.perl6.org/S26.html>.
146150
=end pod

0 commit comments

Comments
 (0)