Struct octocrab::markdown::MarkdownHandler

pub struct MarkdownHandler<'octo> { /* private fields */ }

Handler for GitHub’s markdown API.

Created with Octocrab::markdown.

Implementations

impl<'octo> MarkdownHandler<'octo>

pub fn render<'r, 'text>( &'r self, text: &'text (impl AsRef<str> + ?Sized) ) -> RenderMarkdownBuilder<'octo, 'r, 'text>

Render an arbitrary Markdown document.

use octocrab::params;

let markdown = octocrab::instance()
    .markdown()
    .render("Comment referencing issue #404")
    .mode(params::markdown::Mode::Gfm)
    .context("owner/repo")
    .send()
    .await?;

pub async fn render_raw(&self, text: impl Into<String>) -> Result<String>

Render a Markdown document in raw mode.

use octocrab::params;

let markdown = octocrab::instance()
    .markdown()
    .render_raw("~~_**Octocrab**_~~")
    .await?;