Skip to content

Commit 8111487

Browse files
committed
cleanup/fixes
1 parent 4406f72 commit 8111487

File tree

5 files changed

+46
-47
lines changed

5 files changed

+46
-47
lines changed

.travis.yml

+4-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ notifications:
1414
git:
1515
depth: 10
1616
before_install:
17+
- sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 379CE192D401AB61
18+
- echo "deb https://dl.bintray.com/nxadm/rakudo-pkg-debs `lsb_release -cs` main" | sudo tee -a /etc/apt/sources.list.d/rakudo-pkg.list
1719
- sudo apt-get update -qq
18-
- sudo apt-get install perl
19-
- wget -O /tmp/perl6.deb https://github.com/nxadm/rakudo-pkg/releases/download/v2018.02.1/rakudo-pkg-Ubuntu14.04_2018.02.1-01_amd64.deb && sudo dpkg -i /tmp/perl6.deb && export PATH=$PATH:/.perl6/bin:/opt/rakudo-pkg/bin && install-zef-as-user && zef install Pod::To::HTML
20+
- sudo apt-get install perl rakudo-pkg
21+
- export PATH=$PATH:/.perl6/bin:/opt/rakudo-pkg/bin && install-zef-as-user && zef install Pod::To::HTML
2022
- curl -L http://cpanmin.us | perl - --sudo App::cpanminus
2123
- sudo cpanm --installdeps --notest Pod::Simple
2224
- sudo pip install docutils

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ or
4545
bundle install
4646
```
4747

48-
from this directory
48+
from this directory.
4949

5050
Usage
5151
-----

lib/github/markups.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,4 @@
5252
)
5353

5454
command(::GitHub::Markups::MARKUP_POD6, :pod62html, /pod6/, ["Perl 6"], "pod6")
55-
command(::GitHub::Markups::MARKUP_POD, :pod2html, /pod$/, ["Pod"], "pod")
55+
command(::GitHub::Markups::MARKUP_POD, :pod2html, /pod/, ["Pod"], "pod")

test/markup_test.rb

+1
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ def test_each_render_has_a_name
9090
assert_equal "asciidoctor", GitHub::Markup.renderer('README.adoc', '== Title').name
9191
assert_equal "restructuredtext", GitHub::Markup.renderer('README.rst', 'Title').name
9292
assert_equal "pod", GitHub::Markup.renderer('README.pod', '=head1').name
93+
assert_equal "pod6", GitHub::Markup.renderer('README.pod6', '=begin pod').name
9394
end
9495

9596
def test_rendering_by_symbol

test/markups/README.pod6.html

+39-43
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,28 @@
11

2-
About the Docs
3-
4-
5-
/* code gets the browser-default font
6-
* kbd gets a slightly less common monospace font
7-
* samp gets the hard pixelly fonts
8-
*/
9-
kbd { font-family: "Droid Sans Mono", "Luxi Mono", "Inconsolata", monospace }
10-
samp { font-family: "Terminus", "Courier", "Lucida Console", monospace }
11-
/* WHATWG HTML frowns on the use of <u> because it looks like a link,
12-
* so we make it not look like one.
13-
*/
14-
u { text-decoration: none }
15-
.nested {
16-
margin-left: 3em;
17-
}
18-
// footnote things:
19-
aside, u { opacity: 0.7 }
20-
a[id^="fn-"]:target { background: #ff0 }
21-
22-
23-
24-
25-
26-
27-
<div></div>
28-
29-
30-
<h1>About the Docs</h1>
31-
<p>Meta-documentation</p>
32-
2+
3+
4+
About the Docs
5+
6+
7+
kbd { font-family: "Droid Sans Mono", "Luxi Mono", "Inconsolata", monospace }
8+
samp { font-family: "Terminus", "Courier", "Lucida Console", monospace }
9+
u { text-decoration: none }
10+
.nested {
11+
margin-left: 3em;
12+
}
13+
aside, u { opacity: 0.7 }
14+
a[id^="fn-"]:target { background: #ff0 }
15+
16+
17+
18+
19+
20+
21+
<div></div>
22+
23+
<h1>About the Docs</h1>
24+
<p>Meta-documentation</p>
25+
3326
<table>
3427
<h2>Table of Contents</h2>
3528
<tr>
@@ -52,24 +45,24 @@ <h2>Table of Contents</h2>
5245
</table>
5346

5447

55-
<div>
56-
<p>This document collection represents the on-going effort to document the Perl 6 programming language with the goals of being: comprehensive; easy to use; easy to navigate; and useful to both newcomers and experienced Perl 6 programmers.</p>
48+
<div>
49+
<p>This document collection represents the on-going effort to document the Perl 6 programming language with the goals of being: comprehensive; easy to use; easy to navigate; and useful to both newcomers and experienced Perl 6 programmers.</p>
5750
<p>An HTML version of the documentation is located online at <a href="https://docs.perl6.org">https://docs.perl6.org</a>.</p>
5851
<p>The official source for this documentation is located at <a href="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 <a href="https://github.com/perl6/doc/blob/master/CONTRIBUTING.md">CONTRIBUTING on GitHub</a>. This document also provides a short introduction to writing Perl 6 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 <a href="https://github.com/perl6/doc/blob/master/CONTRIBUTING.md">CONTRIBUTING on GitHub</a>. This document also provides a short introduction to writing Perl 6 Pod files, which can be rendered into HTML and other formats.</p>
6053
<h1><a href="#___top" title="go to top of document">Structure</a></h1>
61-
<p>All of the documentation is written in Perl 6 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 Perl 6 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>
6255
<h1><a href="#___top" title="go to top of document">Generating HTML from Pod</a></h1>
6356
<p>To generate HTML from the Pod files, you'll need:</p>
6457
<ul>
6558
<li>
66-
<p>A recent version of the Rakudo Perl 6 compiler</p>
59+
<p>A recent version of the Rakudo Perl 6 compiler</p>
6760
</li>
6861
<li>
69-
<p>The Perl 6 modules Pod::To::HTML, Pod::To::BigPage, and URI::Escape (can be installed via <a href="https://github.com/ugexe/zef">zef</a>).</p>
62+
<p>The Perl 6 modules Pod::To::HTML, Pod::To::BigPage, and URI::Escape (can be installed via <a href="https://github.com/ugexe/zef">zef</a>).</p>
7063
</li>
7164
<li>
72-
<p><strong>Optional</strong>: <a href="http://graphviz.org">GraphViz</a>, for creating graphs of the relationships between Perl 6 types</p>
65+
<p><strong>Optional</strong>: <a href="http://graphviz.org">GraphViz</a>, for creating graphs of the relationships between Perl 6 types</p>
7366
</li>
7467
<li>
7568
<p><strong>Optional</strong>: <a href="https://github.com/atom/highlights">Atom Highlights</a> and <a href="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>
7871
<p>To generate the documentation into the <code>html/</code> folder, run:</p>
7972
<pre>perl6 htmlify.p6
8073
</pre>
81-
<p>To host the documentation from a web server, have Perl 5 and Mojolicious::Lite installed, then run:</p>
74+
<p>To host the documentation from a web server, have Perl 5 and Mojolicious::Lite installed, then run:</p>
8275
<pre>perl app.pl daemon
8376
</pre>
8477
<h1><a href="#___top" title="go to top of document">Contributing</a></h1>
85-
<p>The documentation is written in Perl 6 Pod.</p>
86-
<p>For a quick introduction to Perl 6 Pod, see <a href="https://docs.perl6.org/language/pod">Perl 6 Pod</a>.</p>
87-
<p>For full details about the Perl 6 Pod specification, see <a href="https://design.perl6.org/S26.html">Synopsis 26, Documentation</a>.</p>
78+
<p>The documentation is written in Perl 6 Pod.</p>
79+
<p>For a quick introduction to Perl 6 Pod, see <a href="https://docs.perl6.org/language/pod">Perl 6 Pod</a>.</p>
80+
<p>For full details about the Perl 6 Pod specification, see <a href="https://design.perl6.org/S26.html">Synopsis 26, Documentation</a>.</p>
8881
<h2><a href="#___top" title="go to top of document">Adding definitions</a></h2>
8982
<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>
9083
<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>
155148
</ul>
156149
<p>Notice that text after a pipe ('|') has no formatting. Also note that <strong> C&lt;&gt; </strong> preserves spaces and treats text as verbatim.</p>
157150

158-
</div>
151+
</div>
152+
153+
154+

0 commit comments

Comments
 (0)