Skip to content

Instantly share code, notes, and snippets.

@roadlittledawn

roadlittledawn/api-doc-example.mdx

Last active August 27, 2020 21:40
Show Gist options
  • Save roadlittledawn/e3aa18a57d7284a4f29506503dcbf14f to your computer and use it in GitHub Desktop.
Save roadlittledawn/e3aa18a57d7284a4f29506503dcbf14f to your computer and use it in GitHub Desktop.
Download ZIP
Raw
api-doc-example.mdx
title contentType templateKey topics metaDescription metaRobots
Title of page
apiDoc
BasicDocPageTemplate
Browser
Browser agent
Browser API

Combine these fields for the main body in this order:

  • field_api_syntax
  • field_api_method_requirements
  • field_api_short_description
  • field_api_method_description
  • field_api_parameters
  • field_api_return_values
  • field_api_examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment