GraphqlMarkdown.MarkdownHelpers (Graphql Markdown v0.5.1)

View Source

A set of helpers to generate proper markdown easily

Summary

Functions

Generates a code block for a GraphQL operation. Only the top-level fields returned are represented in the code block. When one of the fields returned is an object, the object's fields are not included in the code block.

Functions

anchor(text, anchor_text \\ nil)

@spec anchor(String.t(), String.t() | nil) :: String.t()

code(text)

@spec code(String.t()) :: String.t()

default_value(defaultValue)

@spec default_value(any()) :: String.t()

graphql_operation_code_block(operation_details)

Generates a code block for a GraphQL operation. Only the top-level fields returned are represented in the code block. When one of the fields returned is an object, the object's fields are not included in the code block.

Example:

  mutation RefreshIdToken($refreshToken: String!) {
    refreshIdToken(refreshToken: $refreshToken) {
      idToken
      userSsoDetails {
      }
    }
  }

In this example, the idToken field is a scalar, so it is included in the code block. In this example the userSsoDetails field is an object, so its fields are not included in the code block.

header(text, level, capitalize \\ false)

@spec header(String.t(), non_neg_integer(), boolean()) :: String.t()

link(text, url \\ nil)

@spec link(String.t(), String.t() | nil) :: String.t()

list(text, level, capitalize \\ false)

@spec list(String.t(), non_neg_integer(), boolean()) :: String.t()

new_line()

@spec new_line() :: String.t()

table(fields, rows)

@spec table(list(), list()) :: String.t()