Dist::Zilla::Plugin::Stenciller::HtmlExamples - Create Html example files from text files parsed with Stenciller
Version 0.0201, released 2016-03-23.
; in dist.ini
; these are the defaults
[Stenciller::HtmlExamples]
source_directory = examples/source
output_directory = examples
template_file = examples/source/template.html
file_pattern = .+\.stencil
output_also_as_html = 0
Dist::Zilla::Plugin::Stenciller::HtmlExamples uses Stenciller and Stenciller::Plugin::ToHtmlPreBlock to turn
stencil files in source_directory (that matches the file_pattern) into
html example files in output_directory by applying the template_file.
This Dist::Zilla plugin does the FileGatherer role.
| Dir | optional, default: examples/source |
read-only |
Path to where the stencil files are.
| Path | optional, default: examples |
read-only |
Path to where the generated files are saved. The output files will have the same basename as the stencil they are based on, but with the suffix replaced by C.
| Str | optional, default: .+\.stencil |
read-only |
This is used as a part of a regular expression (so do not use start and end anchors) to find stencil files in the C.
| AbsFile | optional, default: 'template.html' in "source_directory" |
read-only |
The template file should be an html file. The first occurence of C<[STENCILS]> will be replaced with the output from L for each stencil.
| Maybe [ Str ] | optional | read-only |
Passed on to the L constructor.
| Bool | optional, default: 0 |
read-only |
Passed on to the L constructor.
https://github.com/Csson/p5-Dist-Zilla-Plugin-Stenciller-HtmlExamples
https://metacpan.org/release/Dist-Zilla-Plugin-Stenciller-HtmlExamples
Erik Carlsson info@code301.com
This software is copyright (c) 2016 by Erik Carlsson.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.