aboutsummaryrefslogtreecommitdiff
path: root/README.pod6
blob: cf6b94ecfa14de190923f27ccd8bffd13429fd57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
=begin pod

=NAME    Pod::To::HTML
=AUTHOR  Patrick Spek <p.spek@tyil.work>
=VERSION 0.0.0

=head1 Synopsis

=begin code
raku --doc=HTML::Section <document>
=end code

=head1 Description

Convert a Pod6 document to HTMLN<Well, just a I<section> of it, really>.

=head1 Installation

=head2 Through C<zef>

L<zef|https://github.com/ugexe/zef> is the standard distribution manager for
L<Raku|https://raku.org>. If you're using an end-user distribution like
L<Rakudo Star|https://rakudo.org/files/star>, it will be installed for you by
default.

C<zef> will install the latest available version from
L<CPAN|http://www.cpan.org/modules/index.html>.

=begin code :lang<sh>
zef install Pod::To::HTML::Section
=end code

=head2 From a downloaded distribution

All official releases are also made available on my L<personal distribution
server|https://dist.tyil.nl/raku/modules/>. These can be installed from the URL
directly.

=begin code :lang<sh>
zef install https://dist.tyil.nl/raku/modules/Pod-To-HTML-Section-0.1.0.tar.gz
=end code

Alternatively, you can download the distribution first, and then install that
copy with C<zef>.

=begin code :lang<sh>
wget https://dist.tyil.nl/raku/modules/Pod-To-HTML-Section-0.1.0.tar.gz
zef install ./Pod-To-HTML-Section-0.1.0.tar.gz
=end code

=head1 Contributing

=head2 Reporting bugs or other feedback

Any bugs or other feedback can be sent to my email address. I generally try to
respond to all mail within 24 hours.

=head2 Proposing code patches

Code patches can also be sent in through email. If you need help to send git
patches through email, you may want to read up on
L<git-send-email.io|https://git-send-email.io/>.

=head3 Testing

If you're working on a code patch, you will more than likely want to test your
own changes to see if they're solving your issue. The easiest way to get the
HTML out on your terminal is to specify your development copy with C<-I> to
give it priority, and using C<raku --doc> as usual.

=begin input
raku -Ilib --doc=HTML::Section <document>
=end input

However, this may be hard to read for most purposes. If you have C<xmllint> and
C<tidy> available on your system, you can use these tools in conjuction with
the C<raku --doc> command to format the HTML.

=begin input
raku -Ilib --doc=HTML::Section <document> \
   | xmllint --html - 2>/dev/null \
   | tidy --indent yes 2>/dev/null
=end input

=head1 License

This module is distributed under the terms of the GNUN<GNU's Not Unix>
AGPLN<Aferro General Public License>, version 3.0.

=end pod