Skip to content

Commit a8d0705

Browse files
committed
Minor changes to docs to force tests
1 parent 22d0418 commit a8d0705

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Render Perl 6 Pod as HTML
66

77
## Install
88

9-
This module is in the [Perl 6 ecosystem](https://modules.perl6.org), so you install it in the usual way:
9+
This module is in the [Perl 6 ecosystem](https://modules.perl6.org),
10+
so you can install it in the usual way:
1011

1112
zef install Pod::To::HTML
1213

@@ -68,19 +69,23 @@ say pod2html $=pod[0], :templates("lib/templates");
6869
## DESCRIPTION
6970

7071
`Pod::To::HTML` takes a Pod 6 tree and outputs correspondingly
71-
formatted HTML. Generally this is done via the command line,
72-
using`perl6 --doc=HTML`, which extracts the pod from the document and
73-
feeds it to `Pod::To::HTML`. The other route is with the `render`
74-
method (called by `--doc=HTML`), which creates a complete HTML
75-
document from the Pod tree it is called with.
72+
formatted HTML using default or provided templates. Generally this is
73+
done via the command line, using`perl6 --doc=HTML`, which extracts the
74+
Pod from the document and feeds it to `Pod::To::HTML`. The other
75+
route, used from your own program, is via the `render` method (called
76+
by `--doc=HTML`), which creates a complete HTML document from the Pod
77+
tree it is called with.
7678

7779
Optionally, a custom header/fooder/head-fields can be
78-
provided. These can be used to link to custom CSS stylesheets and
80+
provided, or even a full template that uses Mustache as a
81+
language. These can be used to link to custom CSS stylesheets and
7982
JavaScript libraries.
8083

8184
## Examples
8285

83-
Check the [`examples`](resources/examples/README.md) directory (which should have been installed with your distribution, or is right here if you download from source) for a few illustrative examples.
86+
Check the [`examples`](resources/examples/README.md) directory (which
87+
should have been installed with your distribution, or is right here if
88+
you download from source) for a few illustrative examples.
8489

8590
## DEBUGGING
8691

0 commit comments

Comments
 (0)