{"id":27197688,"url":"https://github.com/preaction/mojolicious-plugin-podviewer","last_synced_at":"2025-04-09T20:29:22.252Z","repository":{"id":56840822,"uuid":"156771736","full_name":"preaction/Mojolicious-Plugin-PODViewer","owner":"preaction","description":"View Perldoc in your Mojolicious website (forked from PODRenderer)","archived":false,"fork":false,"pushed_at":"2021-05-09T02:07:39.000Z","size":127,"stargazers_count":2,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-06-18T21:43:04.090Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Raku","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/preaction.png","metadata":{"files":{"readme":"README.mkdn","changelog":"CHANGES","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-08T21:32:47.000Z","updated_at":"2021-05-09T02:07:40.000Z","dependencies_parsed_at":"2022-08-29T01:51:23.314Z","dependency_job_id":null,"html_url":"https://github.com/preaction/Mojolicious-Plugin-PODViewer","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preaction%2FMojolicious-Plugin-PODViewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preaction%2FMojolicious-Plugin-PODViewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preaction%2FMojolicious-Plugin-PODViewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/preaction%2FMojolicious-Plugin-PODViewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/preaction","download_url":"https://codeload.github.com/preaction/Mojolicious-Plugin-PODViewer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248106796,"owners_count":21048797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-09T20:29:21.422Z","updated_at":"2025-04-09T20:29:22.237Z","avatar_url":"https://github.com/preaction.png","language":"Raku","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/preaction/Mojolicious-Plugin-PODViewer.svg?branch=master)](https://travis-ci.org/preaction/Mojolicious-Plugin-PODViewer)\n[![Coverage Status](https://coveralls.io/repos/preaction/Mojolicious-Plugin-PODViewer/badge.svg?branch=master)](https://coveralls.io/r/preaction/Mojolicious-Plugin-PODViewer?branch=master)\n\n# NAME\n\nMojolicious::Plugin::PODViewer - POD renderer plugin\n\n# VERSION\n\nversion 0.007\n\n# SYNOPSIS\n\n    # Mojolicious (with documentation browser under \"/perldoc\")\n    my $route = $app-\u003eplugin('PODViewer');\n    my $route = $app-\u003eplugin(PODViewer =\u003e {name =\u003e 'foo'});\n    my $route = $app-\u003eplugin(PODViewer =\u003e {preprocess =\u003e 'epl'});\n\n    # Mojolicious::Lite (with documentation browser under \"/perldoc\")\n    my $route = plugin 'PODViewer';\n    my $route = plugin PODViewer =\u003e {name =\u003e 'foo'};\n    my $route = plugin PODViewer =\u003e {preprocess =\u003e 'epl'};\n\n    # Without documentation browser\n    plugin PODViewer =\u003e {no_perldoc =\u003e 1};\n\n    # foo.html.ep\n    %= pod_to_html \"=head1 TEST\\n\\nC\u003c123\u003e\"\n\n    # foo.html.pod\n    =head1 \u003c%= uc 'test' %\u003e\n\n# DESCRIPTION\n\n[Mojolicious::Plugin::PODViewer](https://metacpan.org/pod/Mojolicious::Plugin::PODViewer) is a renderer for Perl's POD (Plain\nOld Documentation) format. It includes a browser to browse the Perl\nmodule documentation as a website.\n\nThis is a fork of the (deprecated) [Mojolicious::Plugin::PODRenderer](https://metacpan.org/pod/Mojolicious::Plugin::PODRenderer).\n\n# OPTIONS\n\n[Mojolicious::Plugin::PODViewer](https://metacpan.org/pod/Mojolicious::Plugin::PODViewer) supports the following options.\n\n## name\n\n    # Mojolicious::Lite\n    plugin PODViewer =\u003e {name =\u003e 'foo'};\n\nHandler name, defaults to `pod`.\n\n## route\n\nThe [route](https://metacpan.org/pod/Mojolicious::Routes::Route) to add documentation to. Defaults to\n`$app-\u003eroutes-\u003eany('/perldoc')`. The new route will have a name of\n`plugin.podviewer`.\n\n## default\\_module\n\nThe default module to show. Defaults to `Mojolicious::Guides`.\n\n## allow\\_modules\n\nAn arrayref of regular expressions that match modules to allow. At least\none of the regular expressions must match. Disallowed modules will be\nredirected to the appropriate page on [http://metacpan.org](http://metacpan.org).\n\n## layout\n\nThe layout to use. Defaults to `podviewer`.\n\n## no\\_perldoc\n\n    # Mojolicious::Lite\n    plugin PODViewer =\u003e {no_perldoc =\u003e 1};\n\nDisable [Mojolicious::Guides](https://metacpan.org/pod/Mojolicious::Guides) documentation browser that will otherwise be\navailable under `/perldoc`.\n\n## preprocess\n\n    # Mojolicious::Lite\n    plugin PODViewer =\u003e {preprocess =\u003e 'epl'};\n\nName of handler used to preprocess POD, defaults to `ep`.\n\n# HELPERS\n\n[Mojolicious::Plugin::PODViewer](https://metacpan.org/pod/Mojolicious::Plugin::PODViewer) implements the following helpers.\n\n## pod\\_to\\_html\n\n    %= pod_to_html '=head2 lalala'\n    \u003c%= pod_to_html begin %\u003e=head2 lalala\u003c% end %\u003e\n\nRender POD to HTML without preprocessing.\n\n# TEMPLATES\n\n[Mojolicious::Plugin::PODViewer](https://metacpan.org/pod/Mojolicious::Plugin::PODViewer) bundles the following templates. To\noverride this template with your own, create a template with the same name.\n\n## podviewer/perldoc.html.ep\n\nThis template displays the POD for a module. The HTML for the documentation\nis in the `perldoc` content section (`\u003c%= content 'perldoc' %\u003e`).\nThe template has the following stash values:\n\n- module\n\n    The current module, with parts separated by `/`.\n\n- cpan\n\n    A link to [http://metacpan.org](http://metacpan.org) for the current module.\n\n- topics\n\n    An array of arrays of topics in the documentation. Each inner array is\n    a set of pairs of `link text` and `link href` suitable to be passed\n    directly to the `link_to` helper. New topics are started by a `=head1`\n    tag, and include all lower-level headings.\n\n## layouts/podviewer.html.ep\n\nThe layout for rendering POD pages. Use this to add stylesheets,\nJavaScript, and additional navigation. Set the `layout` option to\nchange this template.\n\n# METHODS\n\n[Mojolicious::Plugin::PODViewer](https://metacpan.org/pod/Mojolicious::Plugin::PODViewer) inherits all methods from\n[Mojolicious::Plugin](https://metacpan.org/pod/Mojolicious::Plugin) and implements the following new ones.\n\n## register\n\n    my $route = $plugin-\u003eregister(Mojolicious-\u003enew);\n    my $route = $plugin-\u003eregister(Mojolicious-\u003enew, {name =\u003e 'foo'});\n\nRegister renderer and helper in [Mojolicious](https://metacpan.org/pod/Mojolicious) application.\n\n# SEE ALSO\n\n[Mojolicious](https://metacpan.org/pod/Mojolicious), [Mojolicious::Guides](https://metacpan.org/pod/Mojolicious::Guides), [https://mojolicious.org](https://mojolicious.org).\n\n# AUTHORS\n\n- Sebastian Riedel \u003ckraih@mojolicious.org\u003e\n- Doug Bell \u003cpreaction@cpan.org\u003e\n\n# CONTRIBUTORS\n\n- brad \u003cbrad@clickmagick.com\u003e\n- CandyAngel \u003ccandyangel@electricjungle.org\u003e\n- Luc Didry \u003cluc@didry.org\u003e\n- Oleg \u003cverdrehung@gmail.com\u003e\n- Tekki \u003ctekki@tekki.ch\u003e\n- Zoffix Znet \u003ccpan@zoffix.com\u003e\n\n# COPYRIGHT AND LICENSE\n\nThis software is copyright (c) 2018 by Sebastian Riedel, Doug Bell.\n\nThis is free software; you can redistribute it and/or modify it under\nthe same terms as the Perl 5 programming language system itself.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpreaction%2Fmojolicious-plugin-podviewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpreaction%2Fmojolicious-plugin-podviewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpreaction%2Fmojolicious-plugin-podviewer/lists"}