{"id":17528201,"url":"https://github.com/mauke/pod-markdown-githubert","last_synced_at":"2026-05-05T17:32:26.806Z","repository":{"id":210163719,"uuid":"725895406","full_name":"mauke/Pod-Markdown-Githubert","owner":"mauke","description":"convert POD to Github-flavored Markdown","archived":false,"fork":false,"pushed_at":"2024-07-11T06:04:30.000Z","size":27,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-26T22:36:54.066Z","etag":null,"topics":["github","markdown","perl","pod"],"latest_commit_sha":null,"homepage":"https://metacpan.org/pod/Pod::Markdown::Githubert","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mauke.png","metadata":{"files":{"readme":".github/README.md","changelog":"Changes","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-01T05:04:52.000Z","updated_at":"2024-07-11T05:56:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"ab249fa8-1ab7-496e-b951-dbca8e5beedc","html_url":"https://github.com/mauke/Pod-Markdown-Githubert","commit_stats":{"total_commits":5,"total_committers":1,"mean_commits":5.0,"dds":0.0,"last_synced_commit":"613458ccd3bb8b626f117dd2b4f5167b73545af0"},"previous_names":["mauke/pod-markdown-githubert"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/mauke/Pod-Markdown-Githubert","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mauke%2FPod-Markdown-Githubert","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mauke%2FPod-Markdown-Githubert/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mauke%2FPod-Markdown-Githubert/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mauke%2FPod-Markdown-Githubert/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mauke","download_url":"https://codeload.github.com/mauke/Pod-Markdown-Githubert/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mauke%2FPod-Markdown-Githubert/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32660258,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-05T11:29:49.557Z","status":"ssl_error","status_checked_at":"2026-05-05T11:29:48.587Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["github","markdown","perl","pod"],"created_at":"2024-10-20T15:28:16.024Z","updated_at":"2026-05-05T17:32:26.789Z","avatar_url":"https://github.com/mauke.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NAME\n\nPod::Markdown::Githubert - convert POD to Github-flavored Markdown\n\n# SYNOPSIS\n\n```perl\nuse Pod::Markdown::Githubert ();\n\nmy $parser = Pod::Markdown::Githubert-\u003enew;\n$parser-\u003eoutput_string(\\my $markdown);\n$parser-\u003eparse_string_document($pod_string);\n\n# see Pod::Markdown docs for the full API\n```\n\n# DESCRIPTION\n\nPod::Markdown::Githubert is a module for converting documents in POD format\n(see [perlpod](https://perldoc.perl.org/perlpod)) to Github-flavored Markdown. It is a subclass of\n[Pod::Markdown](https://metacpan.org/pod/Pod%3A%3AMarkdown) (which see for API documentation) that adds the following\nGithub-specific enhancements and fixes:\n\n- Internal links (of the form `L\u003c/foo\u003e`) are converted to something that\nhopefully matches how Github generates HTML ids for Markdown headings. In\nshort, internal links to a section of the current page should just work when\nrendered on Github.\n- Github-specific Markdown code can be embedded literally using a\n`=for github-markdown` paragraph or\n`=begin github-markdown ... =end github-markdown` section.\n\n    In other words, if you want to render e.g. a badge, but only on Github, not all\n    Markdown renderers, put it in a `=for github-markdown` paragraph.\n\n- External links to module documentation normally point to\n[https://metacpan.org/](https://metacpan.org/). But that doesn't work for some of the manual pages\nincluded with Perl because they are only generated when perl is built (such as\n[perlapi](https://perldoc.perl.org/perlapi)), so this module redirects all `perlXYZ` links to\n[https://perldoc.perl.org/](https://perldoc.perl.org/), which has the full set.\n- Verbatim paragraphs are translated to fenced code blocks (surrounded by\n```` ``` ````) with normalized indentation (meaning it doesn't matter whether the\nparagraph is indented by 1 space, 4 spaces, or 23 spaces in the POD source; it\nwill generated the same Markdown).\n- Code blocks containing ```` ``` ```` are rendered correctly, as are code blocks in\nnested structures (such as list items) even when a numbered list item starts\nwith a code block.\n- Syntax highlighting can be enabled by tagging each code block with its\nlanguage. As this module translates a POD document, it keeps a global \"current\nlanguage\" setting, which is applied to every verbatim paragraph. Initially the\n\"current language\" is empty, which just produces ordinary ```` ``` ```` code blocks.\n\n    A `=for highlighter language=FOO` paragraph sets the \"current language\" to\n    *FOO*. (More specifically, you can put multiple *KEY=VALUE* options in a\n    `=for highlighter` paragraph, but this module only looks at the `language`\n    option.) If you only want to set the \"current language\" to *FOO*, you can also\n    write `=for highlighter FOO` (that is, `language` is the default option).\n\n    The \"current language\" is applied to all following verbatim paragraphs and\n    produces ```` ```FOO ```` tagged code blocks:\n\n    ```pod\n    =for highlighter language=perl\n\n        my $dog = \"spot\";\n\n    ... other stuff ...\n\n        my $car = \"cdr\";\n\n    =for highlighter language=html\n\n        \u003cp\u003eHello!\u003c/p\u003e\n    ```\n\n    produces the following Markdown code:\n\n    ````markdown\n    ```perl\n    my $dog = \"spot\";\n    ```\n\n    ... other stuff ...\n\n    ```perl\n    my $car = \"cdr\";\n    ```\n\n    ```html\n    \u003cp\u003eHello!\u003c/p\u003e\n    ```\n    ````\n\n- `$` characters are escaped in plain text segments because otherwise Github\nwill try to render any random text that happens to sit between two dollar signs\nas TeX-style math.\n- Text in italics is rendered using `*`, not `_`. This is because Github\ndisplays `_N_th` verbatim as \"\\_N\\_th\", but `*N*th` as \"*N*th\". The latter is\nwhat we want for POD like `I\u003cN\u003eth`.\n\n# SEE ALSO\n\n[Pod::Markdown](https://metacpan.org/pod/Pod%3A%3AMarkdown), [perlpod](https://perldoc.perl.org/perlpod)\n\n# AUTHOR\n\nLukas Mai, `\u003clmai at web.de\u003e`\n\n# COPYRIGHT \u0026 LICENSE\n\nCopyright 2023-2024 Lukas Mai.\n\nThis module is free software; you can redistribute it and/or modify it under\nthe terms of either: the GNU General Public License as published by the Free\nSoftware Foundation; or the Artistic License.\n\nSee [https://dev.perl.org/licenses/](https://dev.perl.org/licenses/) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmauke%2Fpod-markdown-githubert","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmauke%2Fpod-markdown-githubert","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmauke%2Fpod-markdown-githubert/lists"}