NAME
Pithub::Markdown - 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 diemy $html = $response->raw_content;
AUTHOR
Johannes Plunien <[email protected]>
COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Johannes Plunien.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.