UndefinedOffset\Markdown\Renderer\GithubMarkdownRenderer
Class GithubMarkdownRenderer
Synopsis
class GithubMarkdownRenderer
implements
IMarkdownRenderer
{
- // members
- private static bool $useGFM = false;
- private static bool $useBasicAuth = false;
- private static $username;
- private static $password;
- // methods
- public bool isSupported()
- public string getRenderedHTML()
- public static void setUseGFM()
- public static bool getUseGFM()
- public void useBasicAuth()
Hierarchy
Uses
- SilverStripe\Core\Config\Configurable
Implements
Members
private
- $password —
- $useBasicAuth — UndefinedOffset\Markdown\Renderer\bool
- $useGFM — UndefinedOffset\Markdown\Renderer\bool
- $username — string
Methods
public
- getRenderedHTML() — Returns the supplied Markdown as rendered HTML
- getUseGFM() — Gets if github flavored markdown is enabled or not globally
- isSupported() — Detects if curl is supported which is required for this renderer
- setUseGFM() — Globally enable or disable github flavored markdown
- useBasicAuth() — Sets whether or not to include the Authorization header in GitHub API requests, both parameters are required to enable basic auth