2
2
3
3
= TITLE About the Docs
4
4
5
- = SUBTITLE Documentation for the Perl 6 Documentation Project
5
+ = SUBTITLE Meta-documentation
6
6
7
7
This document collection represents the on-going effort to document the Perl 6 programming
8
8
language with the goals of being: comprehensive; easy to use; easy to
@@ -17,19 +17,19 @@ GitHub|https://github.com/perl6/doc>.
17
17
18
18
This particular document is a quick overview of the process
19
19
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.
22
22
23
23
= head1 Structure
24
24
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/ >
26
26
directory, and the C < doc/Language/ > and C < doc/Type/ > sub-directories.
27
27
These files are processed as collections of definitions or
28
28
"documentables", which are then post-processed and linked together.
29
29
30
- = head1 Generating HTML from POD
30
+ = head1 Generating HTML from Pod
31
31
32
- To generate HTML from the POD files, you'll need:
32
+ To generate HTML from the Pod files, you'll need:
33
33
34
34
= item A recent version of the Rakudo Perl 6 compiler
35
35
@@ -39,7 +39,7 @@ To generate HTML from the POD files, you'll need:
39
39
= item B < Optional > : L < GraphViz|http://graphviz.org > , for creating graphs
40
40
of the relationships between Perl 6 types
41
41
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
43
43
highlighting
44
44
45
45
To generate the documentation into the C < html/ > folder, run:
@@ -57,6 +57,12 @@ perl app.pl daemon
57
57
58
58
= head1 Contributing
59
59
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
+
60
66
= head2 Adding definitions
61
67
62
68
Documentables can be defined using an C < =headN > Pod directive, where
@@ -141,6 +147,4 @@ renders like this
141
147
142
148
Notice that text after a pipe ('|') has no formatting. Also note that B < V < C <> > >
143
149
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 > .
146
150
= end pod
0 commit comments