Comment Writing

Comments are a great way to add context to your code and explain your thought process to others. So we added some features to make it easier. Our comment writing system is like most other markdown editors like Discord or GitHub. You can learn more about markdown syntax from markdownguide.org.

Getting Started

We support most of the markdown syntax and some additional features. Some is inspired by Discord and YouTube. We dont allow HTML tags or any Heading.

Spoilers

At first, we have spoilers. You can hide text by wrapping it in two pipes. (||)

You can click on the spoiler to reveal the text.

TimeStamp

You can alos add a timestamp to your comment. It will be clickable and if you click on it, it will take you to that time in the video.

The format is HH:MM:SS or MM:SS.

Highlight

You can highlight text by wrapping it in two equal signs. (==)

Underline

You can underline text by wrapping it in two dashes. (--)

Bold

To bold text, add two asterisks or underscores before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters. (**) or (__)

Italic

To italicize text, add one asterisk or underscore before and after a word or phrase. To italicize the middle of a word for emphasis, add one asterisk without spaces around the letters. (*) or (_)

Strikethrough

To strikethrough text, add two tildes before and after a word or phrase. (~~)

Horizontal Rules

To create a horizontal rule, use three or more asterisks (***) or underscores (___) on a line by themselves.

Blockquotes

To create a blockquote, add a > in front of a paragraph.

> Dorothy followed her through many of the beautiful rooms in her castle.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

Blockquotes with Multiple Paragraphs

Blockquotes can contain multiple paragraphs. Add a > on the blank lines between the paragraphs.

> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Nested Blockquotes

Blockquotes can be nested. Add a >> in front of the paragraph you want to nest.

> Dorothy followed her through many of the beautiful rooms in her castle.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Lists

You can organize items into ordered and unordered lists.

Ordered lists

To create an ordered list, add line items with numbers followed by periods. The numbers don’t have to be in numerical order, but the list should start with the number one.

Unordered Lists

To create an unordered list, add dashes (-), asterisks (*), or plus signs (+) in front of line items. Indent one or more items to create a nested list.

Starting Unordered List Items With Numbers

If you need to start an unordered list item with a number followed by a period, you can use a backslash (\) to escape the period.

Links

To create a link, you can just type the link or enclose the link text in brackets (e.g., [Duck Duck Go]) and then follow it immediately with the URL in parentheses (e.g., (https://duckduckgo.com)).

You can optionally add a title for a link. This will appear as a tooltip when the user hovers over the link. To add a title, enclose it in quotation marks after the URL.

Images

To add an image, add an exclamation mark (!), followed by alt text in brackets, and the path or URL to the image asset in parentheses. You can optionally add a title in quotation marks after the path or URL.

Code

To highlight your text as code, wrap your text in backticks. (`)

To create a code block, wrap your text in three backticks. (```)

const text = "Hello, World!";
console.log(text);

Task Lists

Task lists (also referred to as checklists and todo lists) allow you to create a list of items with checkboxes. In Markdown applications that support task lists, checkboxes will be displayed next to the content. To create a task list, add dashes (-) and brackets with a space ([ ]) in front of task list items. To select a checkbox, add an x in between the brackets ([x]).

Tables

To add a table, use three or more hyphens (---) to create each column’s header, and use pipes (|) to separate each column. For compatibility, you should also add a pipe on either end of the row.

Cell widths can vary, as shown below. The rendered output will look the same.

You can align text in the columns to the left, right, or center by adding a colon (:) to the left, right, or on both side of the hyphens within the header row.