Skip to content

Panel: Markdown

The Markdown panel is used to provide static information about the dashboard, using Markdown syntax. Markdown is a lightweight markup language for creating formatted text using a plain-text editor 1.

It can be used to provide context about the dashboard using some basic text formatting, links, lists, tables, and an image.

Example showing color match specific icons

Important Considerations

This panel supports static information entered in the configuration editor for the panel.

  • It does not support asset signal, meta, or other information from the ExoSense application solution.
  • HTML is not supported
  • One image can be uploaded and used per panel.

Configuration options

Editing in the Panel Configuration

  • The Panel name
  • The markup text editor allows writing your content and seeing realtime view of how it will look.
  • You are able to upload one image for this panel.

Supported Syntax

Example

Headers

Headers
    # h1 Heading
    ## h2 Heading
    ### h3 Heading
    #### h4 Heading
    ##### h5 Heading
    ###### h6 Heading

Result

headers

Emphasis

Emphasis
    **This is bold text**

    __This is bold text__

    *This is italic text*

    _This is italic text_

    ~~Strikethrough~~

Result

headers

Lists

Lists
    Unordered

    + Create a list by starting a line with `+`, `-`, or `*`
    + Sub-lists are made by indenting 2 spaces:
      - Marker character change forces new list start:
        * Ac tristique libero volutpat at
        + Facilisis in pretium nisl aliquet
        - Nulla volutpat aliquam velit
    + Very easy!

    Ordered

    1. Lorem ipsum dolor sit amet
    2. Consectetur adipiscing elit
    3. Integer molestie lorem at massa


    1. You can use sequential numbers...
    1. ...or keep all the numbers as `1.`

    Start numbering with offset:

    57. foo
    1. bar

Result

headers

Tables

Tables
    | Option | Description |
    | ------ | ----------- |
    | data   | path to data files to supply the data that will be passed into templates. |
    | engine | engine to be used for processing templates. Handlebars is the default. |
    | ext    | extension to be used for dest files. |

    Right aligned columns

    | Option | Description |
    | ------:| -----------:|
    | data   | path to data files to supply the data that will be passed into templates. |
    | engine | engine to be used for processing templates. Handlebars is the default. |
    | ext    | extension to be used for dest files. |

Result

headers

Blockquotes

Blockquotes
    > Blockquotes can also be nested...
    >> ...by using additional greater-than signs right next to each other...
    > > > ...or with spaces between arrows.

Result

headers

Code

Code
    Inline `code`

    Indented code

        // Some comments
        line 1 of code
        line 2 of code
        line 3 of code


    Block code "fences"

    ```
    Sample text here...
    ```

    Syntax highlighting

    ``` js
    var foo = function (bar) {
      return bar++;
    };

    console.log(foo(5));
    ```

Result

headers

Misc

Horizontal Lines
    ___

    ***

    ---
Links
    Containing Link and Link text

    [Home Page](https://www.exosite.com)

    Auto links

    <http://www.exosite.com>

Result

headers

Images

The panel has a built-in menu button to upload an image and also to delete it. The panel itself supports 1 uploaded image, but can also be used with an external linked image.

Example

  • Image styling and resize is not supported, images should be sized and formatted before.
  • Uploaded images must be deleted using the trashcan button if you want to upload a new one
Images
    An image at an external link

    ![Description](https://docs.exosite.io/assets/images/exosense-screens.png)

    Uploaded Images will automatically generate the text to show

    ![Uploaded Image](#uploadedImage:1aae6e69-0830-4ef3-8e6f-20d2459bdec8)

Result

headers

  1. https://en.wikipedia.org/wiki/Markdown ↩