Git Product home page Git Product logo

pod-to-html's Introduction

Pod::To::HTML

Render Perl 6 Pod as HTML

SYNOPSIS

From the command line:

perl6 --doc=HTML lib/FancyModule.pm > FancyModule.html

From within Perl 6:

#Pod Block
=pod My I<super B<awesome>> embedded C<pod>
     document!

say Pod::To::HTML.render($=pod[0]);

#Pod file
say Pod::To::HTML.render('your/file.pod'.IO, 
                         header => "your-custom-header-inside-body", 
                         footer => "your-custom-footer-inside-body", 
                         head-fields => "tags-inside-head", 
                         lang        => "document language (defaults to 'en')",
                         default-title = 'No =title was found so we use this');

#Pod string
my $pod = q:to/END/;
=pod
My I<super B<awesome>> embedded C<pod>
     document!
END
say Pod::To::HTML.render($pod, 
                         header => "your-custom-header-inside-body", 
                         footer => "your-custom-footer-inside-body", 
                         head-fields => "tags-inside-head", 
			 lang        => "document language (defaults to 'en')",
                         default-title = 'No =title was found so we use this');

DESCRIPTION

Pod::To::HTML takes a Pod tree and outputs correspondingly formatted HTML.
Generally this is done via the command line, usingperl6 --doc=HTML, which extracts the pod from the document and feeds it to Pod::To::HTML.
The other route is with the render method (called by --doc=HTML), which creates a complete HTML document from the Pod tree it is called with. Optionally, a custom header/fooder/head-fields can be provided. These can be used to link to custom css stylesheets and javascript libraries.

pod-to-html's People

Contributors

moritz avatar mouq avatar gfldex avatar timo avatar zoffixznet avatar hoelzro avatar shimmerfairy avatar llfourn avatar hankache avatar raydiak avatar teodozjan avatar andreoss avatar lizmat avatar szabgab avatar pnu avatar slobo avatar tbrowder avatar

Watchers

rosa maria palacios juncosa avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.