Guys! In this quick tutorial, I'll be showing you how to make your posts pretty using Markdown styling!
First we'll learn about headers. A header starts with a hash symbol
# followed by a space:
# 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
A header with 4 hash symbols
Alternatively, you can also "underline" a text with
- to produce headers
First header (Same as # First header) -------------- Second header (Same as ## Second header) ===========
You can make italic, bold or
Put the text between a pair of
_ to make it italic.
*italic text* _also italic_
_ on both sides of text to make it bold.
**bold text** __also bold__
You can also do a
strikethrough by putting two tildes (
~) on each side:
It's ok to mix up those stylings:
**_~~bold, italic and strikethrough~~_**
bold, italic and strikethrough
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
- followed by a space:
* this + that - and stuff
- and stuff
Use indentations of 2 spaces to make sublists
* list item * sublist item * yet another sublist item
- list item
- sublist item
- yet another sublist item
Just paste the URL and it'll work:
If you want custom link text, try this:
The Markdown syntax for images is pretty simple:
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.
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`
$ 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. ```
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!!!"); ```
while (true) console.log("MARKDOWN IS AWESOME!!!");
To do blockquotes put a
> before each line of the block:
> Timchen is the greatest and > we should praise him
Timchen is the greatest and
we should praise him
Don't forgot to leave a blank line after each blockquote!
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
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!
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.
Great guide. Thank you for posting.
I would ask that you fix one thing, though: # is not a hashtag. The important part of a hashtag is actually the tag, not the hash. As you already know, the tag is a word or phrase (e.g. "life goals") that can be searched for in a database and that is associated with an object (e.g. a blog post, tweet, or photo); the hash symbol in front of the tag is merely a decoration that distinguishes it from the surrounding text.
The # symbol has been around for a very long time and goes by many names: pound sign, number sign, hash symbol, hash mark, octothorp(e), octothorn(e), or even tic-tac-toe board. But the # symbol on its own, without a word that acts as a tag, is not a hashtag.
Please fix this in your tutorial. My fellow faculty members and I would appreciate it.
(This may seem pedantic, but an important part of education [and life] is understanding context. As educators, we should reinforce critical thinking skills and analysis of context. Thank you.)
I'm going to link this underneath he authoring textbox so that people can read it before the post.