logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Pithub::Markdown - Github v3 Markdown API

Attributes

mode
       The rendering mode. Can be either:

       •   "markdown" to render a document in plain Markdown, just like README.md files are rendered.

       •   "gfm" to render a document in GitHub Flavored Markdown, which creates links for user mentions as well
           as references to SHA-1 hashes, issues, and pull requests.

   context
       The  repository  context  to  use when creating references in "gfm" mode.  Omit this parameter when using
       "markdown" mode.

Author

       Johannes Plunien <plu@cpan.org>

Methods

render
       Render an arbitrary Markdown document

           POST /markdown

       Example:

           use Pithub::Markdown;

           my $response = Pithub::Markdown->new->render(
               data => {
                   text => "Hello world github/linguist#1 **cool**, and #1!",
                   context => "github/gollum",
                   mode => "gfm",
               },
           );

           # Note that response is NOT in JSON, so ->content will die
           my $html = $response->raw_content;

Name

       Pithub::Markdown - Github v3 Markdown API

Version

       version 0.01043

See Also