Skip to main content

Markdown Syntax Guide

This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.

This is a note to highlight important information.
This is a tip to help users.
This is a warning to alert users.
This is a danger to warn users.
This is a success message.

Demo - Support for Diagrams

Feel free to switch between the light and dark themes to see how the diagram adapts its colors accordingly.

# Mermaid Diagrams

2014-01-052014-01-122014-01-192014-01-262014-02-022014-02-092014-02-16A task          Task in Another another task    Another task    SectionAnotherA Gantt Diagram

Get more examples at About Mermaid

Demo - Multiline Codes

199
200
201
202
203
204
205
206
int main() {
    int a = 1;
    if (a == 999)
        // This is a very long comment to test the `overflow` attribute defined in CSS. The `overflow` property in CSS deals with the content when it overflows the block-level container. It can take the following values: `visible` (default), `hidden`, `scroll`, `auto`, and `clip`.
        // If `visible` is specified, the content is not clipped and can render outside the container. If `hidden` is specified, the content is clipped and the rest of the content will be invisible. If `scroll` is specified, the browser should provide a scrolling mechanism for the user to access the clipped content.
    }
    return 0;
}

# Truth Table

ItemLine NumbersHighlight LinesAnchor LinesWide CodeBlock ScrollSupported
Full Feature Supportturetruetrue
tabletruetrue
tabletruefalse
inline
turetruefalse
turefalsefalse
falsetrue/
Basic Supportfalsefalse/

Note: Anubis2 does not support hl_inline=true