Troubleshooting
Unexpected behavior can occur in rendered pages due to a number of different reasons. One of these reasons is when the rendered pages are not valid HTML.
Incorrect HTML markup can be due to:
<p>
or <span>
elements<tbody>
tags<span>
elements
<span id="example">
Animal | Trainable? | Price | Remarks
:------|:----------:|------:|--------
Ants | no | 5 |
Bees | no | 20 |
Cats | yes | 100 |
</span>
The table specified by the Markdown syntax above will be rendered as a block-level element, which will be included in a inline span element. This makes the HTML output invalid.
A possible fix for the above situation is to wrap the table in a <div>
element instead:
<div id="example">
Animal | Trainable? | Price | Remarks
:------|:----------:|------:|--------
Ants | no | 5 |
Bees | no | 20 |
Cats | yes | 100 |
</div>
If you encounter issues in rendering Markdown in a component, it is likely that the Markdown is not being properly recognized due to syntax errors. Signposting is required to inform Markdown to parse the content of a presentation component as Markdown rather than plain text.
You could signpost Markdown either by:
<markdown>
(block level elements) or <md>
(inline level elements) tags to wrap the Markdown content.CODE:
<box>
**Example1**
</box>
<box>
<md> **Example2** </md>
</box>
<box>
<markdown> **Example3** </markdown>
</box>
OUTPUT:
Example1
Example3
<include>
If you notice that relative links in a page pointing to another page no longer works after adding it into a page via <include>
, it may be because the relative link no longer points to the correct address in the new page with <include>
.
To solve this, change the relative URL into an absolute URL by adding {{ baseUrl }}
. This will ensure that the link will always point to the same address regardless of the page it is included in.