rendered_markdown

Creates, updates, deletes, gets or lists a rendered_markdown resource.

Overview

Name	rendered_markdown
Type	Resource
Id	github.markdown.rendered_markdown

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
render	insert	text		Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as issues:read or pull_requests:read.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description

INSERT examples

render

Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as issues:read or pull_requests:read.

INSERT INTO github.markdown.rendered_markdown (
text,
mode,
context
)
SELECT 
'{{ text }}' /* required */,
'{{ mode }}',
'{{ context }}'
;

Manifest

# Description fields are for documentation purposes
- name: rendered_markdown
props:
  - name: text
    value: "{{ text }}"
    description: |
      The Markdown text to render in HTML.
  - name: mode
    value: "{{ mode }}"
    description: |
      The rendering mode.
    valid_values: ['markdown', 'gfm']
    default: markdown
  - name: context
    value: "{{ context }}"
    description: |
      The repository context to use when creating references in `gfm` mode.  For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.