Pithub::Markdown(3pm)

Pithub::Markdown3pm

Github v3 markdown api

Version

version 0.01043

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.

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;

Releases

4 releases since Debian 10 (Buster); the text changed 3 times.

  1. 10
  2. 11
  3. 12
  4. 13

Author

Johannes Plunien <[email protected]>

From libpithub-perl 0.01043-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.