icon
menu

Markdown

Markdown is supported for resource descriptions, relation descriptions, sequence step descriptions, and perspective notes. Markdown allows you to add bold, italicized, code text and code blocks, insert links, add headers and bullet points, and add links to perspectives.

The following examples show how markdown can be added to a resource’s description.

Yaml Result

Bold Text

- name: Resource A
  subtitle: A Resource
  description: This description has **bold** text
 A resource with bold text in the description

Italicized Text

- ...
  description: This description has *italicized* 
  text
 A resource with italic text in the description

Code Text (Inline)

...
  description: This description has `code` text
 A resource with code text in the description

Code Text (Block)

- ...
  description: |-
    This description has a code block:
  
    ```
    int main() {
      printf("Hello World");
      return 0;
    }
    ```
A resource with code text in the description

External Links

- ...
  description: This description has a
        [link](https://www.ilograph.com)
 A resource with a link in the description

Headers

- ...
  description: |-
    This descriptions has multiple headers:
    # Header 1
    ## Header 2
    ### Header 3
    etc.
 A resource with a link in the description

Lists

- ...
  description: |-
    This descriptions has a bulleted list:
    - Item 1
    - Item 2
    - Item 3
 A resource with a link in the description

Internal Links to a Perspective

- ...
  description: This description has a link to
  the [Code](#Code) perspective

Internal Links to a Subsequence

- ...
  description: This description has a link to
  the [Code](#Code/SubequenceName) perspective
 A resource with a link to a perspective in the description

All special characters used in markdown can be escaped with a backslash (\) character.

While these examples show markdown used in resource descriptions, keep in mind that markdown can also be used in perspective notes, walkthroughs, and relation and sequence step descriptions.