68
A Quick Guide to Repl.it Talk Markdown
JSer (1087)

Guys! In this quick tutorial, I'll be showing you how to make your posts pretty using Markdown styling!

Headers

First we'll learn about headers. A header starts with a hash symbol # followed by a space:

# A header

Output:

A header

Headers can be a variety of sizes. A smaller header starts with more hash symbols. The number of hash symbols can be 1 to 6:

#### A header with 4 hash symbols

Output:

A header with 4 hash symbols

Alternatively, you can also "underline" a text with = or - to produce headers

First header (Same as # First header)
--------------
Second header (Same as ## Second header)
===========

Text Styles

You can make italic, bold or strikethrough text.
Put the text between a pair of * or _ to make it italic.

*italic text*
_also italic_

Output:
italic text
also italic

Put two * or _ on both sides of text to make it bold.

**bold text**
__also bold__

Output:
bold text
also bold

You can also do a strikethrough by putting two tildes (~) on each side:

~~strikethrough~~

Output:
strikethrough

It's ok to mix up those stylings:

**_~~bold, italic and strikethrough~~_**

Output:
bold, italic and strikethrough


Lists

There's two kind of lists in Markdown: unordered (bulleted) and ordered (numbered). Since repl.it talk Markdown doesn't support ordered lists (sadly), we'll only deal with unordered lists.

An unordered list item starts with either a *, + or - followed by a space:

* this
+ that
- and stuff

Output:

  • this
  • that
  • and stuff

Use indentations of 2 spaces to make sublists

* list item
  * sublist item
  * yet another sublist item

Output:

  • list item
    • sublist item
    • yet another sublist item

Links

Just paste the URL and it'll work:

https://repl.it

Output:
https://repl.it

If you want custom link text, try this: [link text](URL):

[Repl.it](https://repl.it)

Output:
Repl.it


Images

The Markdown syntax for images is pretty simple: ![alt text](URL):

![Repl.it logo](https://repl.it/public/images/icon-square.png)

Output:

Wait... what if my image is stored in my computer? It doesn't have a URL!
Well, repl.it provided an easy way to upload images. All you need is to click the select files button below to upload it. After that, you'll see the Markdown code for your image in the text box.


Code

And finally, code!! Inline code and code blocks are widely used in repl.it talk since repl.it talk is a platform for coders to share.
Wrap a pair of backticks (`) around text to make a span of code (inline code):

`$ node index.js`

Output:
$ node index.js

To indicate a block of code, put three backticks (```) at both the start and end of your code:

```
This is a code block.
Everything here is monospaced.
```

Output:

This is a code block.
Everything here is monospaced.

Additionally, repl.it supports code block syntax highlighting, which is pretty useful for emphasizing readability.
Just put the language name (or its short form) after the three backticks:

```js
while (true) 
  console.log("MARKDOWN IS AWESOME!!!");
```

Output:

while (true) 
  console.log("MARKDOWN IS AWESOME!!!");

Blockquotes

To do blockquotes put a > before each line of the block:

> Timchen is the greatest and
> we should praise him

Output:

Timchen is the greatest and
we should praise him

Don't forgot to leave a blank line after each blockquote!


Horzontal rules

A horzontal rule (a line that separates content) can be made of either three asterisks (*) or underscores (_):

There's a horizontal rule below
***
There's a horizontal rule above

Output:
There's a horizontal rule below


There's a horizontal rule above

That's all what I can teach in this very tutorial. Start using Markdown to style your posts, and find more about it!

You are viewing a single comment. View All
6
robmuh (16)

Great start but I would like to point out that much of what you have documented is in varying degrees of adoption every place that Markdown is used.

Strikethrough specifically is not Markdown (and never was) but has been picked up by CommonMark.

Links using just https://some will not be detected inline unless surrounded with < and > in 90% of Markdown processors.

Sublist indentation varies wildly across engines and should just be avoided all together (as Medium does). The two space indicated in this tutorial is not supported by GitHub, markdown-it, and many others that require 4 spaces (but that seems to change regularly). Best to avoid indented lists.

Use of headers beyond third level has no style difference and are not picked up by VuePress and others. Stick with three.

"Code" is actually a "Code Fence" more commonly referred to as a "Fence" because more than just code is written in them.

I suggest sticking with BaseML to be sure the Markdown you use can be used anywhere including REPL.it, GitHub, Discord, Reddit, and elsewhere. It is also a lot less stuff to remember.

1
TheDrone7 (510)

@robmuh I agree with you although if you look closely at the title, it's clearly specified that this is a guide to "Repl.it Talk Markdown" meaning the practices shown here can be used and will work properly in repl.it, the post never says anything about other markdowns making your comment's 2nd to 5th paragraphs along with the 7th one meaningless. ( I was short of words here don't mean to offend or anything.)

1
robmuh (16)

@TheDrone7 I get that a lot of people don't care about cross-system compatibility. Just pointing it out for those who do.

1
TheDrone7 (510)

@robmuh I did say I agree with you for the most part.