You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>This document collection represents the on-going effort to document the Perl6 programming language with the goals of being: comprehensive; easy to use; easy to navigate; and useful to both newcomers and experienced Perl6 programmers.</p>
48
+
<div>
49
+
<p>This document collection represents the on-going effort to document the Perl6 programming language with the goals of being: comprehensive; easy to use; easy to navigate; and useful to both newcomers and experienced Perl6 programmers.</p>
57
50
<p>An HTML version of the documentation is located online at <ahref="https://docs.perl6.org">https://docs.perl6.org</a>.</p>
58
51
<p>The official source for this documentation is located at <ahref="https://github.com/perl6/doc">perl6/doc on GitHub</a>.</p>
59
-
<p>This particular document is a quick overview of the process described in more detail in <ahref="https://github.com/perl6/doc/blob/master/CONTRIBUTING.md">CONTRIBUTING on GitHub</a>. This document also provides a short introduction to writing Perl6 Pod files, which can be rendered into HTML and other formats.</p>
52
+
<p>This particular document is a quick overview of the process described in more detail in <ahref="https://github.com/perl6/doc/blob/master/CONTRIBUTING.md">CONTRIBUTING on GitHub</a>. This document also provides a short introduction to writing Perl6 Pod files, which can be rendered into HTML and other formats.</p>
60
53
<h1><ahref="#___top" title="go to top of document">Structure</a></h1>
61
-
<p>All of the documentation is written in Perl6 Pod and kept in the <code>doc/</code> directory, and the <code>doc/Language/</code> and <code>doc/Type/</code> sub-directories. These files are processed as collections of definitions or "documentables", which are then post-processed and linked together.</p>
54
+
<p>All of the documentation is written in Perl6 Pod and kept in the <code>doc/</code> directory, and the <code>doc/Language/</code> and <code>doc/Type/</code> sub-directories. These files are processed as collections of definitions or "documentables", which are then post-processed and linked together.</p>
62
55
<h1><ahref="#___top" title="go to top of document">Generating HTML from Pod</a></h1>
63
56
<p>To generate HTML from the Pod files, you'll need:</p>
64
57
<ul>
65
58
<li>
66
-
<p>A recent version of the Rakudo Perl6 compiler</p>
59
+
<p>A recent version of the Rakudo Perl6 compiler</p>
67
60
</li>
68
61
<li>
69
-
<p>The Perl6 modules Pod::To::HTML, Pod::To::BigPage, and URI::Escape (can be installed via <ahref="https://github.com/ugexe/zef">zef</a>).</p>
62
+
<p>The Perl6 modules Pod::To::HTML, Pod::To::BigPage, and URI::Escape (can be installed via <ahref="https://github.com/ugexe/zef">zef</a>).</p>
70
63
</li>
71
64
<li>
72
-
<p><strong>Optional</strong>: <ahref="http://graphviz.org">GraphViz</a>, for creating graphs of the relationships between Perl6 types</p>
65
+
<p><strong>Optional</strong>: <ahref="http://graphviz.org">GraphViz</a>, for creating graphs of the relationships between Perl6 types</p>
73
66
</li>
74
67
<li>
75
68
<p><strong>Optional</strong>: <ahref="https://github.com/atom/highlights">Atom Highlights</a> and <ahref="https://atom.io/packages/language-perl6">language-perl6</a>, for syntax highlighting</p>
@@ -78,13 +71,13 @@ <h1><a href="#___top" title="go to top of document">Generating HTML from Pod</a>
78
71
<p>To generate the documentation into the <code>html/</code> folder, run:</p>
79
72
<pre>perl6 htmlify.p6
80
73
</pre>
81
-
<p>To host the documentation from a web server, have Perl5 and Mojolicious::Lite installed, then run:</p>
74
+
<p>To host the documentation from a web server, have Perl5 and Mojolicious::Lite installed, then run:</p>
82
75
<pre>perl app.pl daemon
83
76
</pre>
84
77
<h1><ahref="#___top" title="go to top of document">Contributing</a></h1>
85
-
<p>The documentation is written in Perl6 Pod.</p>
86
-
<p>For a quick introduction to Perl6 Pod, see <ahref="https://docs.perl6.org/language/pod">Perl6 Pod</a>.</p>
87
-
<p>For full details about the Perl6 Pod specification, see <ahref="https://design.perl6.org/S26.html">Synopsis 26, Documentation</a>.</p>
78
+
<p>The documentation is written in Perl6 Pod.</p>
79
+
<p>For a quick introduction to Perl6 Pod, see <ahref="https://docs.perl6.org/language/pod">Perl6 Pod</a>.</p>
80
+
<p>For full details about the Perl6 Pod specification, see <ahref="https://design.perl6.org/S26.html">Synopsis 26, Documentation</a>.</p>
88
81
<h2><ahref="#___top" title="go to top of document">Adding definitions</a></h2>
89
82
<p>Documentables can be defined using an <code>=headN</code> Pod directive, where <code>N</code> is greater than zero (e.g., <code>=head1</code>, <code>=head2</code>, …).</p>
90
83
<p>All of the paragraphs and blocks following that directive, up until the next directive of the same level, will be considered part of the documentable. So, in:</p>
@@ -155,4 +148,7 @@ <h2><a href="#___top" title="go to top of document">Adding definitions</a></h2>
155
148
</ul>
156
149
<p>Notice that text after a pipe ('|') has no formatting. Also note that <strong> C<> </strong> preserves spaces and treats text as verbatim.</p>
0 commit comments