Skip to content

Commit

Permalink
cleanup/fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
kivikakk committed Dec 10, 2018
1 parent 4406f72 commit 8111487
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 47 deletions.
6 changes: 4 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ notifications:
git:
depth: 10
before_install:
- sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 379CE192D401AB61
- 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
- sudo apt-get update -qq
- sudo apt-get install perl
- 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
- sudo apt-get install perl rakudo-pkg
- export PATH=$PATH:/.perl6/bin:/opt/rakudo-pkg/bin && install-zef-as-user && zef install Pod::To::HTML
- curl -L http://cpanmin.us | perl - --sudo App::cpanminus
- sudo cpanm --installdeps --notest Pod::Simple
- sudo pip install docutils
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ or
bundle install
```

from this directory
from this directory.

Usage
-----
Expand Down
2 changes: 1 addition & 1 deletion lib/github/markups.rb
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@
)

command(::GitHub::Markups::MARKUP_POD6, :pod62html, /pod6/, ["Perl 6"], "pod6")
command(::GitHub::Markups::MARKUP_POD, :pod2html, /pod$/, ["Pod"], "pod")
command(::GitHub::Markups::MARKUP_POD, :pod2html, /pod/, ["Pod"], "pod")
1 change: 1 addition & 0 deletions test/markup_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ def test_each_render_has_a_name
assert_equal "asciidoctor", GitHub::Markup.renderer('README.adoc', '== Title').name
assert_equal "restructuredtext", GitHub::Markup.renderer('README.rst', 'Title').name
assert_equal "pod", GitHub::Markup.renderer('README.pod', '=head1').name
assert_equal "pod6", GitHub::Markup.renderer('README.pod6', '=begin pod').name
end

def test_rendering_by_symbol
Expand Down
82 changes: 39 additions & 43 deletions test/markups/README.pod6.html
Original file line number Diff line number Diff line change
@@ -1,35 +1,28 @@

About the Docs


/* code gets the browser-default font
* kbd gets a slightly less common monospace font
* samp gets the hard pixelly fonts
*/
kbd { font-family: "Droid Sans Mono", "Luxi Mono", "Inconsolata", monospace }
samp { font-family: "Terminus", "Courier", "Lucida Console", monospace }
/* WHATWG HTML frowns on the use of <u> because it looks like a link,
* so we make it not look like one.
*/
u { text-decoration: none }
.nested {
margin-left: 3em;
}
// footnote things:
aside, u { opacity: 0.7 }
a[id^="fn-"]:target { background: #ff0 }






<div></div>


<h1>About the Docs</h1>
<p>Meta-documentation</p>



About the Docs


kbd { font-family: "Droid Sans Mono", "Luxi Mono", "Inconsolata", monospace }
samp { font-family: "Terminus", "Courier", "Lucida Console", monospace }
u { text-decoration: none }
.nested {
margin-left: 3em;
}
aside, u { opacity: 0.7 }
a[id^="fn-"]:target { background: #ff0 }






<div></div>

<h1>About the Docs</h1>
<p>Meta-documentation</p>

<table>
<h2>Table of Contents</h2>
<tr>
Expand All @@ -52,24 +45,24 @@ <h2>Table of Contents</h2>
</table>


<div>
<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>
<div>
<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>
<p>An HTML version of the documentation is located online at <a href="https://docs.perl6.org">https://docs.perl6.org</a>.</p>
<p>The official source for this documentation is located at <a href="https://github.com/perl6/doc">perl6/doc on GitHub</a>.</p>
<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>
<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>
<h1><a href="#___top" title="go to top of document">Structure</a></h1>
<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>
<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>
<h1><a href="#___top" title="go to top of document">Generating HTML from Pod</a></h1>
<p>To generate HTML from the Pod files, you'll need:</p>
<ul>
<li>
<p>A recent version of the Rakudo Perl 6 compiler</p>
<p>A recent version of the Rakudo Perl 6 compiler</p>
</li>
<li>
<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>
<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>
</li>
<li>
<p><strong>Optional</strong>: <a href="http://graphviz.org">GraphViz</a>, for creating graphs of the relationships between Perl 6 types</p>
<p><strong>Optional</strong>: <a href="http://graphviz.org">GraphViz</a>, for creating graphs of the relationships between Perl 6 types</p>
</li>
<li>
<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>
Expand All @@ -78,13 +71,13 @@ <h1><a href="#___top" title="go to top of document">Generating HTML from Pod</a>
<p>To generate the documentation into the <code>html/</code> folder, run:</p>
<pre>perl6 htmlify.p6
</pre>
<p>To host the documentation from a web server, have Perl 5 and Mojolicious::Lite installed, then run:</p>
<p>To host the documentation from a web server, have Perl 5 and Mojolicious::Lite installed, then run:</p>
<pre>perl app.pl daemon
</pre>
<h1><a href="#___top" title="go to top of document">Contributing</a></h1>
<p>The documentation is written in Perl 6 Pod.</p>
<p>For a quick introduction to Perl 6 Pod, see <a href="https://docs.perl6.org/language/pod">Perl 6 Pod</a>.</p>
<p>For full details about the Perl 6 Pod specification, see <a href="https://design.perl6.org/S26.html">Synopsis 26, Documentation</a>.</p>
<p>The documentation is written in Perl 6 Pod.</p>
<p>For a quick introduction to Perl 6 Pod, see <a href="https://docs.perl6.org/language/pod">Perl 6 Pod</a>.</p>
<p>For full details about the Perl 6 Pod specification, see <a href="https://design.perl6.org/S26.html">Synopsis 26, Documentation</a>.</p>
<h2><a href="#___top" title="go to top of document">Adding definitions</a></h2>
<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>
<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>
Expand Down Expand Up @@ -155,4 +148,7 @@ <h2><a href="#___top" title="go to top of document">Adding definitions</a></h2>
</ul>
<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>

</div>
</div>



0 comments on commit 8111487

Please sign in to comment.