Struct roctogen::endpoints::markdown::Markdown

pub struct Markdown<'api> { /* fields omitted */ }

Implementations

impl<'api> Markdown<'api>

pub async fn render_async(
    &self,
    body: PostMarkdownRender
) -> Result<String, MarkdownRenderError>

---

Render a Markdown document

GitHub API docs for render

---

pub fn render(
    &self,
    body: PostMarkdownRender
) -> Result<String, MarkdownRenderError>

---

Render a Markdown document

GitHub API docs for render

---

pub async fn render_raw_async(
    &self,
    body: String
) -> Result<String, MarkdownRenderRawError>

---

Render a Markdown document in raw mode

You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.

GitHub API docs for render_raw

---

pub fn render_raw(&self, body: String) -> Result<String, MarkdownRenderRawError>

---

Render a Markdown document in raw mode

You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.

GitHub API docs for render_raw

---