{"id":16010187,"url":"https://github.com/nichtich/pod-pandoc","last_synced_at":"2025-03-18T02:32:23.389Z","repository":{"id":45193889,"uuid":"80555313","full_name":"nichtich/Pod-Pandoc","owner":"nichtich","description":"process Plain Old Documentation format with Pandoc","archived":false,"fork":false,"pushed_at":"2022-07-13T05:55:07.000Z","size":97,"stargazers_count":5,"open_issues_count":9,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T06:21:07.454Z","etag":null,"topics":["documentation","pandoc","perl","pod"],"latest_commit_sha":null,"homepage":"https://metacpan.org/pod/Pod::Pandoc","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nichtich.png","metadata":{"files":{"readme":"README.md","changelog":"Changes","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-31T19:43:53.000Z","updated_at":"2022-09-20T02:09:51.000Z","dependencies_parsed_at":"2022-09-02T11:50:35.330Z","dependency_job_id":null,"html_url":"https://github.com/nichtich/Pod-Pandoc","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nichtich%2FPod-Pandoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nichtich%2FPod-Pandoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nichtich%2FPod-Pandoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nichtich%2FPod-Pandoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nichtich","download_url":"https://codeload.github.com/nichtich/Pod-Pandoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243894540,"owners_count":20365048,"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":["documentation","pandoc","perl","pod"],"created_at":"2024-10-08T13:04:55.479Z","updated_at":"2025-03-18T02:32:23.060Z","avatar_url":"https://github.com/nichtich.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NAME\n\nPod::Pandoc - process Plain Old Documentation format with Pandoc\n\n# STATUS\n\n[![Unix Build Status](https://travis-ci.org/nichtich/Pod-Pandoc.svg)](https://travis-ci.org/nichtich/Pod-Pandoc)\n[![Windows Build status](https://ci.appveyor.com/api/projects/status/lfskwt20v0ofj5ix?svg=true)](https://ci.appveyor.com/project/nichtich/pod-pandoc)\n[![Coverage Status](https://coveralls.io/repos/nichtich/Pod-Pandoc/badge.svg)](https://coveralls.io/r/nichtich/Pod-Pandoc)\n[![Kwalitee Score](http://cpants.cpanauthors.org/dist/Pod-Pandoc.png)](http://cpants.cpanauthors.org/dist/Pod-Pandoc)\n[![Code Climate Issue Count](https://codeclimate.com/github/nichtich/Pod-Pandoc/badges/issue_count.svg)](https://codeclimate.com/github/nichtich/Pod-Pandoc)\n[![Documentation Status](https://readthedocs.org/projects/pod-pandoc/badge/?version=latest)](http://pod-pandoc.readthedocs.io/?badge=latest)\n\n# DESCRIPTION\n\nThe Plain Old Documentation format (Pod) is a markup language used to document\nPerl code (see [perlpod](https://metacpan.org/pod/perlpod) for reference). Several Perl modules exist to process\nand convert Pod into other formats.\n\nPod::Pandoc is an attempt to unify and extend Pod converting based on the\n[Pandoc](http://pandoc.org/) document converter. Pandoc supports more document\nformats in a more detailled and uniform way than any set of Perl modules will\never do. For this reason Pod::Pandoc provides methods to convert Pod to the\nPandoc document model for further processing with Pandoc.\n\n# OUTLINE\n\n- [pod2pandoc](https://metacpan.org/pod/pod2pandoc) is a command line script to convert Pod to any format supported\nby Pandoc.\n- [App::pod2pandoc](https://metacpan.org/pod/App::pod2pandoc) provides functionality of [pod2pandoc](https://metacpan.org/pod/pod2pandoc) to be used in Perl code.\n- [Pod::Simple::Pandoc](https://metacpan.org/pod/Pod::Simple::Pandoc) converts Pod to the abstract document model of Pandoc.\n- [Pod::Pandoc::Modules](https://metacpan.org/pod/Pod::Pandoc::Modules) manages a set of Pod documents of Perl modules.\n\n# REQUIREMENTS\n\nInstallation of this module does not require Pandoc but it is needed to make\nactual use of it. See [http://pandoc.org/installing.html](http://pandoc.org/installing.html) for installation.\n\n# USAGE EXAMPLES\n\n## Replace [pod2html](https://metacpan.org/pod/pod2html)\n\n    # pod2html --infile=input.pm --css=style.css --title=TITLE \u003e output.html\n    pod2pandoc input.pm --css=style.css --toc --name -o output.html\n\nPandoc option `--toc` corresponds to pod2html option `--index` and is\ndisabled by default. pod2pandoc adds title and subtitle from NAME section.\n\n## Replace [pod2markdown](https://metacpan.org/pod/pod2markdown)\n\n    # pod2markdown input.pod\n    pod2pandoc input.pod -t markdown\n\n    # pod2markdown input.pod output.md\n    pod2pandoc input.pod -o output.md\n\n## GitHub wiki\n\nThe [GitHub wiki of this project](https://github.com/nichtich/Pod-Pandoc/wiki)\nis automatically populated with its module documentation.  Wiki pages\nare created with [pod2pandoc](https://metacpan.org/pod/pod2pandoc) as following (see script `update-wiki.sh`):\n\n    pod2pandoc lib/ script/ wiki/ --ext md --index Home --wiki -t markdown_github\n\n## Sphinx and Read The Docs\n\nThe [Sphinx documentation generator](https://sphinx-doc.org/) recommends\ndocuments in reStructureText format. It further requires a configuration file\n`conf.py` and some links need to be adjusted because Pandoc does not support\nwikilinks in rst output format (see script `update-docs.sh`:\n\n    pod2pandoc lib/ script/ docs/ --ext rst --wiki -t rst --standalone\n    perl -pi -e 's!`([^`]+) \u003c([^\u003e]+)\u003e`__!-e \"docs/$2.rst\" ? \":doc:`$1 \u003c$2\u003e`\" : \"`$1 \u003c$2\u003e`__\"!e' docs/*.rst\n    make -C docs html\n\nThe result is published automatically at\n[http://pod-pandoc.rtfd.io/en/latest/Pod-Pandoc.html](http://pod-pandoc.rtfd.io/en/latest/Pod-Pandoc.html).\n\n# SEE ALSO\n\nThis module is based on the wrapper module [Pandoc](https://metacpan.org/pod/Pandoc) to execute pandoc from Perl\nand on the module [Pandoc::Elements](https://metacpan.org/pod/Pandoc::Elements) for pandoc document processing.\n\nThis module makes obsolete several specialized `Pod::Simple::...` modules such\nas [Pod::Simple::HTML](https://metacpan.org/pod/Pod::Simple::HTML), [Pod::Simple::XHTML](https://metacpan.org/pod/Pod::Simple::XHTML), [Pod::Simple::LaTeX](https://metacpan.org/pod/Pod::Simple::LaTeX),\n[Pod::Simple::RTF](https://metacpan.org/pod/Pod::Simple::RTF) [Pod::Simple::Text](https://metacpan.org/pod/Pod::Simple::Text), [Pod::Simple::Wiki](https://metacpan.org/pod/Pod::Simple::Wiki), [Pod::WordML](https://metacpan.org/pod/Pod::WordML),\n[Pod::Perldoc::ToToc](https://metacpan.org/pod/Pod::Perldoc::ToToc) etc. It also covers batch conversion such as\n[Pod::Simple::HTMLBatch](https://metacpan.org/pod/Pod::Simple::HTMLBatch), [Pod::ProjectDocs](https://metacpan.org/pod/Pod::ProjectDocs), [Pod::POM::Web](https://metacpan.org/pod/Pod::POM::Web), and\n[Pod::HtmlTree](https://metacpan.org/pod/Pod::HtmlTree).\n\n# AUTHOR\n\nJakob Voß \u003cjakob.voss@gbv.de\u003e\n\n# CONTRIBUTORS\n\nBenct Philip Jonsson\n\n# COPYRIGHT AND LICENSE\n\nCopyright 2017- Jakob Voß\n\nGNU General Public License, Version 2\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnichtich%2Fpod-pandoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnichtich%2Fpod-pandoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnichtich%2Fpod-pandoc/lists"}