Skip to main content
Pulumi logo Pulumi logo
  1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. RegistryContentNode

RegistryContentNode

    A content node. Clients render ‘markdown’ for any ‘kind’ they do not recognize.

    Properties

    • kind string required
      Node kind. Known kinds: ’text’, ‘code’, ’language-chooser’, ‘os-chooser’. A ‘code’ node appears where a ’lang’ or ‘os’ filter collapsed a chooser to its single matching snippet. Render ‘markdown’ for unrecognized kinds.
    • markdown string required
      Markdown content. For ’text’ nodes, the content itself. For chooser nodes, a concatenation of options for fallback rendering.
    • options array[RegistryContentNodeOption] optional
      Options for chooser nodes; absent for ’text'.
    • kind string optional
      Option kind. Known kinds: ‘code’ (content is a bare code snippet with no fence) and ’text’ (content is markdown). Render ‘markdown’ for unrecognized kinds.
    • language string optional
      The language this option applies to (for ’language-chooser’ nodes). One of: typescript, python, go, csharp, java, yaml. When an option declares several languages this is the first of ’languages'.
    • languages array[string] optional
      Every language this option applies to (for ’language-chooser’ nodes). A single option can serve several languages, e.g. a snippet shared by csharp and fsharp.
    • os string optional
      The operating system this option applies to (for ‘os-chooser’ nodes). One of: linux, macos, windows.
    • content string required
      The content for this option, typically a code snippet or instructions. Interpretation depends on ‘kind’; prefer ‘markdown’ unless you need the bare snippet.
    • markdown string required
      The option rendered as markdown, whatever its kind: ‘code’ options are returned fenced with their language. Render this when you do not handle ‘kind’ specifically.

      The infrastructure as code platform for any cloud.