Markdown Help

TODO gallery example?

What is Markdown?

Markdown is a lightweight markup language that allows you to add formatting elements to plaintext, helping maintain visual clarity directly within the text. Using simple symbols, you can style your text easily without the need for a specialized text editor. We’ve made a deliberate choice to keep the syntax slightly more strict and expressive, in order to minimize unintended collisions with regular text.

The most essential controls can be applied during text editing without any need to know markdown, thanks to the toolbar above the note editor. For advanced or additional options, this help page serves as a reference.

Text styling

Control	Name	Example	Result
**	Bold	This is bold.	This is bold.
//	Italic	This is //italic//.	This is Italic.
__	Underline	This is __underline__.	This is Underline.
***	Marker	This is *marker*.	This is marker.
~~	Strikethrough	This is ~~strikethrough~~.	This is ~~strikethrough~~.

Resources

Link [[ ]]

Links are defined using the syntax [[LINK DESCRIPTION]]. The DESCRIPTION is optional and, if provided, will be used as the display text for the link. There are three types of links:

External Link: Recognized by a full URL, it is considered an external link. For example, [[https://www.google.com This is a link to the Google site]]
Note Link: Links to another note within Notius. This type of link uses the structure NOTE-id, where "id" is the displayed note ID (found in the top left corner of the note). For example, [[NOTE-12 link to my note #12]]
File Link: If the "LINK" value matches the name of an attached file of the given note, it will create a link to that file. For example [[my_document.pdf Some report]]

Single Image or Video << >>

The syntax to include a single image is <<LINK CAPTION>>, or <<video:LINK CAPTION>> to embed a video player. The CAPTION is optional and will be used as the display text for the media. The LINK can be of two types:

External Resource: Recognized by a full URL. For Example <<https://www.example.com/nice-image.jpg Some Image>>
File Link: If the "LINK" value matches the name of an attached file of the given note, use that file. For example <<logo.jpg Logo>>.

Multiple Media Files <<< >>>

Experimental, Published Only

The syntax for including multiple media files is <<<BODY>>>. If the BODY is empty, all images attached to the given note are included directly in the document, displayed one after another. A non-empty body activates media previews with gallery functions. The body can contain instructions separated by "|", which include:

PREVIEW_COUNT N: Specifies the number of preview images to generate, where N is the number.
FILES file_name_1 file_name_2: Includes specific files by name.
FILTER STR: Includes only those files that contain the substring STR in their names.
gallery: Forces the use of a gallery view instead of direct media inclusion when no other instructions are provided.

Example: <<<FILTER dog|PREVIEW_COUNT 6>>> - This gallery will contain all images with "dog" in their names, displaying a total of 6 preview images.

Document Structure

Headings =

Headings are defined with "=" sign at the beginning of the line. The number of signs determines its level (e.g., "====" for h4), alternatively, you can use "=Number" to specify it by number (e.g., "=4" for h4).

Lists # or -

Ordered: use "#" at the beginning of the line (or multiple ones for nested lists).

Unordered: use "-" at the beginning of the line (or multiple ones for nested lists).

Simple Table |

Use the "|" symbol at the beginning of the line to start a table, add another one for each subsequent cell. For example: "|First Column|Second Column|Third Column".

Horizontal Line /line

Use "/line" to define a horizontal rule.

Info block /block

Use "/block some text" on a new line to display "some text" inside a block with a different background.

Symbols & Status Tags

Control	Example
??	?? - multiple occurences of "?" sign will emphasise it
!!	!! - multiple occurences of "!" sign will emphasise it
/todo	TODO
/progress	IN PROGRESS
/done	DONE
/flag
/bell
/warning
/error
/info

Code Snippets ^^

Code snippets are defined by placing "^^" on a new line to open and close the snippet. This displays the text within a block that provides additional features. The full syntax for the opening tag is:

"^^language=filename.ext Some caption"

language: Adds syntax highlighting for supported languages.
=filename.ext: If provided, it will be displayed and made available for download under that filename (*Published Only).
caption: Sets the title of the code box.

Example:

^^typescript=tracker.ts Some TypeScript Tracker

some code

Would render as:

class Tracker {
    private count: number;
    private description: string;

    constructor(description: string) {
        this.count = 0;
        this.description = description;
    }
    //....
}

tracker.ts - Some TypeScript Tracker
class Tracker {
    private count: number;
    private description: string;

    constructor(description: string) {
        this.count = 0;
        this.description = description;
    }
    //....
}

Emojis :)

Experimental*

:)	🙂		:D	😀		:P	😛		:'(	😢
;)	😉		:(	🙁		:O	😮		>:(	😡

Advanced

Control	Name	Description
\n	New Line	Explicitly places a new line, useful in single-line instructions like /block
\	Escape Character	the following character will not be recognized as a control character
/SOMETHING_TO_HIDE/	Comment	Content inside will not be rendered, useful for hiding information in the note
"""	Not evaluated string	Writes text exactly as entered without processing markup; can be multiline
""""	Evaluated string	To wrap evaluated text. For example, to define a parameter of a function.
$$( FUNCTION )$$	Extensions to markdown	Allows for the inclusion of functions and additional markdown features

Secret Function

Creates a mini-component with a hidden value — useful for storing information that shouldn't be immediately visible. You can reveal the value when needed or copy it directly. This is useful when working with internal or non-critical values you want to keep out of sight by default.

Definition	Result
$$(secret hiddenValue)$$ or $$(secret """hiddenValue""")$$

Note: Hidden values are not rendered in shared notes and boards. For highly sensitive information, consider using an encrypted note instead.

Sub/Sup Function

Creates inline subscript and superscript elements. Useful for mathematical notation, units, or any structured expressions.

Name	Example	Result
superscript	A$$(sub 2)$$	A₂
subscript	B$$(sup 3)$$	B³

CSS Function

Experimental*

Defines a CSS class, for example, applying a red color to bold text within the provided text.

Parameters:

Display Rule: Specifies the display property for the wrapping element (e.g., block, inline).
Classes Definition: Provided as a "Not evaluated string" to prevent markup processing.
Contents: The text or elements to which the CSS will be applied.

Syntax Example:

$$(css block """ 
> * {padding: 10px; display: inline-block;}
b {color:red;letter-spacing:5px;transition:all .2s} 
b:hover {color:#6b40f7;transform:scale(1.5);} 
i {color:blue;background-color:#e0e0e0} 
""" some text with **bold** and //italic//)$$

<code>
$$(css block """ 
> * {padding: 10px; display: inline-block;}
b {color:red;letter-spacing:5px;transition:all .2s} 
b:hover {color:#6b40f7;transform:scale(1.5);} 
i {color:blue;background-color:#e0e0e0} 
""" some text with **bold** and //italic//)$$

Renders as:

some text with bold and italic

Styled Function

Experimental*

Applies quick CSS styling to text. The first parameter must be a "Not evaluated string" to ensure that the CSS is not processed as markdown.

Syntax Example:

$$(styled """color:red""" this
//italic//
text
is red)$$

<code>
$$(styled """color:red""" this
//italic//
text
is red)$$

Renders as:

this
italic
text
is red

HTML Function

Experimental*

This function enables the inclusion of raw HTML within a note. All JavaScript execution is disabled in the Notius app to ensure security, but it can be used in published documents.

Syntax Example:

$$(html <table>
<tr><th>This is html</th></tr>
<tr><td>table cell</td></tr>
</table>
)$$

<code>
$$(html <table>
<tr><th>This is html</th></tr>
<tr><td>table cell</td></tr>
</table>
)$$

Renders as:

This is html
table cell

Experimental* - This feature is currently under evaluation and may be subject to changes.

Published Only* - This functionality is available only in published documents, not within the Notius app itself.

Notius.io employs stricter markdown controls to prevent frequent collisions with common characters. If such collisions occur and you do not need markdown for the current note, you can disable it by turning off the "Enable markdown" option in the note menu. If control characters are needed, there are techniques available such as escaping or writing text as unevaluated (\ or """unevaluated""").

"::Some text" can appear at the beginning of the editor (or in the first editor of a structured note). While not part of markdown itself, it represents the title of the note. Therefore, if the first line starts with ::, it is designated as the title of the note, and no markdown formatting will be applied to this line.

Documentation

Markdown Help

What is Markdown?

Text styling

Resources

Link [[ ]]

Single Image or Video << >>

Multiple Media Files <<< >>>

Experimental*, Published Only*

Document Structure

Headings =

Lists # or -

Simple Table |

Horizontal Line /line

Info block /block

Symbols & Status Tags

Code Snippets ^^

Emojis :)

Experimental*

Advanced

Secret Function

Sub/Sup Function

CSS Function

Experimental*

Styled Function

Experimental*

HTML Function

Experimental*

Experimental, Published Only