Note

Note

The note resource represents a single page of content that can be displayed in a tab.

This resource does not have the capability to embed quiz and task components, because it does not keep track of any progress.


resource "note" "name" {
  ...
}

Attributes

Attribute
Description

File file required type: string

The file that contains the note markdown.

file = "notes/addendum.md"

Variables variables type: map[string]string

A key/value map of variables that are passed to the markdown. Handlebars templates are used to substitute the variables. The placeholders will be replaced with the variable values at runtime.

variables = {
  version = "v0.1.0"
  url = "https://example.com/archive.zip"
  count = 10
}

Computed Attributes

These attributes are computed when the config is parsed and applied, and are therefore only known at parsetime or runtime.

Attribute
Description

Meta ID meta.id string

The full ID of the resource e.g. `resource.type.name`. This is computed from the full resource path:

// given the following resource
resource "container" "ubuntu" {
  ...
}

// the resulting id will be
resource.container.ubuntu

Meta Type meta.type string

The type of the resource. This taken from the type label of the resource definition.

// given the following resource
resource "container" "ubuntu" {
  ...
}

// the resulting type will be
container

Meta Name meta.name string

The name of the resource. This taken from the name label of the resource definition.

// given the following resource
resource "container" "ubuntu" {
  ...
}

// the resulting name will be
ubuntu

Last updated