Skip to content

Commit 2be0430

Browse files
committed
Initial CI test of new CI setup
And some doc tweaks
1 parent f8580c3 commit 2be0430

File tree

9 files changed

+211
-87
lines changed

9 files changed

+211
-87
lines changed

.github/workflows/linux.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Linux
2+
3+
on:
4+
push:
5+
branches:
6+
- '*'
7+
tags-ignore:
8+
- '*'
9+
pull_request:
10+
11+
jobs:
12+
raku:
13+
strategy:
14+
matrix:
15+
os:
16+
- ubuntu-latest
17+
raku-version:
18+
- 'latest'
19+
runs-on: ${{ matrix.os }}
20+
steps:
21+
- uses: actions/checkout@v3
22+
- uses: Raku/setup-raku@v1
23+
with:
24+
raku-version: ${{ matrix.raku-version }}
25+
- name: Install Dependencies
26+
run: zef install --/test --test-depends --deps-only .
27+
- name: Run Special Tests
28+
run: raku run-tests -i

.github/workflows/macos.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: MacOS
2+
3+
on:
4+
push:
5+
branches:
6+
- '*'
7+
tags-ignore:
8+
- '*'
9+
pull_request:
10+
11+
jobs:
12+
raku:
13+
strategy:
14+
matrix:
15+
os:
16+
- macos-latest
17+
raku-version:
18+
- 'latest'
19+
runs-on: ${{ matrix.os }}
20+
steps:
21+
- uses: actions/checkout@v3
22+
- uses: Raku/setup-raku@v1
23+
with:
24+
raku-version: ${{ matrix.raku-version }}
25+
- name: Install Dependencies
26+
run: zef install --/test --test-depends --deps-only .
27+
- name: Run Special Tests
28+
run: raku run-tests -i

.github/workflows/test.yaml

Lines changed: 0 additions & 23 deletions
This file was deleted.

.github/workflows/windows.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Windows
2+
3+
on:
4+
push:
5+
branches:
6+
- '*'
7+
tags-ignore:
8+
- '*'
9+
pull_request:
10+
11+
jobs:
12+
raku:
13+
strategy:
14+
matrix:
15+
os:
16+
- windows-latest
17+
raku-version:
18+
- 'latest'
19+
runs-on: ${{ matrix.os }}
20+
steps:
21+
- uses: actions/checkout@v3
22+
- uses: Raku/setup-raku@v1
23+
with:
24+
raku-version: ${{ matrix.raku-version }}
25+
- name: Install Dependencies
26+
run: zef install --/test --test-depends --deps-only .
27+
- name: Run Special Tests
28+
run: raku run-tests -i

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
precomp/
1+
.precomp/
22
/Pod-To-HTML-*
33
*.rakucov

META6.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
"authors": [
44
"Raku Community modules"
55
],
6+
"build-depends": [
7+
],
68
"depends": {
79
"runtime": {
810
"requires": [
@@ -31,9 +33,14 @@
3133
"templates/main.mustache",
3234
"css/github.css"
3335
],
36+
"source-url": "https://github.com/raku-community-modules/Pod-To-HTML.git",
3437
"support": {
3538
"bugtracker": null,
3639
"source": "git://github.com/Raku/Pod-To-HTML.git"
3740
},
41+
"tags": [
42+
],
43+
"test-depends": [
44+
],
3845
"version": "v0.8.1"
3946
}

README.md

Lines changed: 69 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
Pod::To::HTML v0.8.1
2-
====================
3-
4-
[![Test in a Raku container](https://github.com/Raku/Pod-To-HTML/actions/workflows/test.yaml/badge.svg)](https://github.com/Raku/Pod-To-HTML/actions/workflows/test.yaml)
1+
[![Actions Status](https://github.com/raku-community-modules/Pod-To-HTML/actions/workflows/linux.yml/badge.svg)](https://github.com/raku-community-modules/Pod-To-HTML/actions) [![Actions Status](https://github.com/raku-community-modules/Pod-To-HTML/actions/workflows/macos.yml/badge.svg)](https://github.com/raku-community-modules/Pod-To-HTML/actions) [![Actions Status](https://github.com/raku-community-modules/Pod-To-HTML/actions/workflows/windows.yml/badge.svg)](https://github.com/raku-community-modules/Pod-To-HTML/actions)
52

3+
Pod::To::HTML
4+
=============
65

76
Raku module to render Pod as HTML.
87

@@ -11,45 +10,43 @@ Synopsis
1110

1211
From the command line:
1312

14-
raku --doc=HTML lib/FancyModule.rakumod > FancyModule.html
13+
$ raku --doc=HTML lib/FancyModule.rakumod > FancyModule.html
1514

1615
From within Raku:
1716

18-
use Pod::To::HTML:auth<github:Raku>;
17+
```raku
18+
use Pod::To::HTML;
1919

20-
# Pod file
21-
say render(
22-
'your/file.pod'.IO,
23-
title => 'My Own Title',
24-
subtitle => 'On the Art of Making Titles',
25-
lang => 'en',
26-
);
20+
# Pod file
21+
say render(
22+
'your/file.pod'.IO,
23+
title => 'My Own Title',
24+
subtitle => 'On the Art of Making Titles',
25+
lang => 'en',
26+
);
27+
```
2728

2829
Installation
2930
------------
3031

3132
From the [Raku ecosystem](https://modules.raku.org):
3233

33-
$ zef install Pod::To::HTML:author<github:Raku>
34+
$ zef install Pod::To::HTML
3435

3536
From source:
3637

37-
$ git clone https://github.com/Raku/Pod-To-HTML.git
38+
$ git clone https://github.com/raku-community-modules/Pod-To-HTML.git
3839
$ cd Pod-To-HTML/
3940
$ zef install .
4041

41-
**Note**: Perl 6 2018.06 introduces changes on how non-breaking whitespace was handled; this is now included in the tests. If the installation fails, please upgrade to Perl 6 >= 2018.06 or simply disregard the test and install with `--force` if that particular feature is of no use to you.
42-
43-
**Note 2**: Perl6 2018.11 introduced handling of Definition blocks, `Defn`. Please upgrade if you are using that feature in the documentation.
44-
4542
Description
4643
-----------
4744

4845
`Pod::To::HTML` takes a Pod tree and outputs correspondingly formatted HTML using a default or provided Mustache template. There are two ways of accomplishing this:
4946

50-
* from the command line, using `raku --doc=HTML`, which extracts the Pod from the document and feeds it to `Pod::To::HTML`.
47+
* from the command line, using `raku --doc=HTML`, which extracts the Pod from the document and feeds it to `Pod::To::HTML`.
5148

52-
* from within a Raku program via the exported `render` subroutine, which creates a complete HTML document from the Pod. This allows more customization (`title`, `subtitle`, and `lang` can override Pod's corresponding semantics, different Mustache template (possibly with partials), additional template variables for the template, etc.) than simply rendering the Pod via `raku --doc=HTML` which just use the default template.
49+
* from within a Raku program via the exported `render` subroutine, which creates a complete HTML document from the Pod. This allows more customization (`title`, `subtitle`, and `lang` can override Pod's corresponding semantics, different Mustache template (possibly with partials), additional template variables for the template, etc.) than simply rendering the Pod via `raku --doc=HTML` which just use the default template.
5350

5451
Exported subroutines
5552
--------------------
@@ -79,20 +76,22 @@ Template information
7976

8077
* `footnotes`: The Pod document's [footnotes](https://docs.raku.org/language/pod#Notes).
8178

82-
Additional information can be made available to the Mustache template by supplying to `render` as named arguments. For example, `css-url => https://design.raku.org/perl.css` will be available to the template as `css-url`.
79+
Additional information can be made available to the Mustache template by supplying to `render` as named arguments.
8380

8481
### Semantic Blocks
8582

8683
Semantic blocks are treated as metadata and supplied as such to a Mustache template. For example, from the Pod document:
8784

88-
=begin pod
89-
=TITLE Classes and objects
90-
=SUBTITLE A tutorial about creating and using classes in Raku
91-
=LANG English
92-
=DATE January 01, 2020
93-
=end pod
85+
```raku
86+
=begin pod
87+
=TITLE Classes and objects
88+
=SUBTITLE A tutorial about creating and using classes in Raku
89+
=LANG English
90+
=DATE January 01, 2020
91+
=end pod
92+
```
9493

95-
the template variables `title`, `subtitle`, `lang`, and `date` are made available to a Mustache template. Both `title` and `subtitle` can be overridden via the `render` subroutine.
94+
The template variables `title`, `subtitle`, `lang`, and `date` are made available to a Mustache template. Both `title` and `subtitle` can be overridden via the `render` subroutine.
9695

9796
**Note**: Pod's semantic blocks can be overridden via `render` by using a variable of the same name.
9897

@@ -104,13 +103,49 @@ Check the [examples](resources/examples/README.md) directory (which should have
104103
Debugging
105104
---------
106105

107-
You can set the `P6DOC_DEBUG` environmental variable to make the module produce some debugging information.
106+
You can set the `RAKUDOC_DEBUG` environmental variable to make the module produce some debugging information.
107+
108+
RAKUDOC_DEBUG=1 raku --doc=HTML lib/FancyModule.rakumod > FancyModule.html
109+
110+
AUTHORS
111+
=======
112+
113+
* Anthony Parsons
114+
115+
* Moritz Lenz
116+
117+
* Timo Paulssen
118+
119+
* Alex Moquin
120+
121+
* Wenzel P. P. Peppmeyer
122+
123+
* Zoffix Znet
108124

109-
P6DOC_DEBUG=1 raku --doc=HTML lib/FancyModule.rakumod > FancyModule.html
125+
* Alex Chen
110126

111-
License
112-
-------
127+
* JJ Merelo
113128

114-
You can use and distribute this module under the terms of the The Artistic License 2.0. See the LICENSE file included in this distribution for complete details.
129+
* Jonathan Stowe
130+
131+
* Richard Hainsworth
132+
133+
* Antonio Gamiz
134+
135+
* Oleksander Kiryuhin
136+
137+
* Elizabeth Mattijsen
138+
139+
And many other Raku Community members.
140+
141+
Source can be located at: https://github.com/raku-community-modules/Pod-To-HTML . Comments and Pull Requests are welcome.
142+
143+
COPYRIGHT AND LICENSE
144+
=====================
145+
146+
Copyright 2011-2025 Raku Community
147+
148+
This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.
115149

116150
The `META6.json` file of this distribution may be distributed and modified without restrictions or attribution.
151+

dist.ini

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name = Pod::To::HTML
2+
3+
[ReadmeFromPod]
4+
filename = doc/Pod-To-HTML.rakudoc
5+
6+
[UploadToZef]
7+
8+
[Badges]
9+
provider = github-actions/linux.yml
10+
provider = github-actions/macos.yml
11+
provider = github-actions/windows.yml

0 commit comments

Comments
 (0)