Skip to main content

MarkDown Intro

· 3 min read
Evan Tay
Evan Tay
Final year Computer Science major at NUS
Arteii
Arteii
Student

just a short intro to markdown and mdx for docusaurus or different tools / websites

You can write content using GitHub-flavored Markdown syntax.

To serve as an example page when styling markdown based Docusaurus sites.

Headers​

H1 - Create the best documentation

H2 - Create the best documentation​

H3 - Create the best documentation​

H4 - Create the best documentation​

H5 - Create the best documentation​
H6 - Create the best documentation​

Emphasis​

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. Scratch this.

Lists​

  1. First ordered list item
  2. Another item
  • Unordered sub-list.
  1. Actual numbers don't matter, just that it's a number
  2. Ordered sub-list
  3. And another item.
  • Unordered list can use asterisks
  • Or minuses
  • Or pluses

I'm an inline-style link

I'm an inline-style link with title

[I'm a reference-style link][arbitrary case-insensitive reference text]

[You can use numbers for reference-style link definitions][1]

Or leave it empty and use the [link text itself].

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com/ or http://www.example.com/ and sometimes example.com (but not on GitHub, for example).

Some text to show that the reference links can follow later.

[arbitrary case-insensitive reference text] https://www.mozilla.org/ [1] http://slashdot.org/ [link text itself] http://www.reddit.com/

Images​

you can import assets and use them like this: (only if you use mdx)

import myImageUrl from "../../static/img/Website-Social-Card.jpeg";

<img src={myImageUrl} width={250} height={250} alt="Example banner" />;
Example banner

Inline-style:

alt text

Reference-style: ![alt text][logo]

[logo] https://arteiii.github.io/img/Website-Social-Card.jpeg "Logo Title Text 2"

Images from any folder can be used by providing path to file. Path should be relative to markdown file.

Code​

var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print(s)
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
var highlightMe = function (){
  console.log("This line can be highlighted!");
};

you can also set titles

```python title="example title"
s = "Python syntax highligh...
example title
s = "Python syntax highlighting"
print(s)

Tables​

Colons can be used to align columns.

TablesAreCool
col 3 isright-aligned$1600
col 2 iscentered$12
zebra stripesare neat$1

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.

MarkdownLessPretty
Stillrendersnicely
123

Blockquotes​

Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.

Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.

Inline HTML​

Definition list
Is something people use sometimes.
Markdown in HTML
Does not work very well. Use HTML tags.

Line Breaks​

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the same paragraph.


Admonitions​

note

This is a note

tip

This is a tip

important

This is important

caution

This is a caution

warning

This is a warning

MDX​

lets you use jsx in markdown

read more

Tabs​

read docu

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
  <TabItem value="apple" label="Apple" default>
    This is an apple 🍎
  </TabItem>
  <TabItem value="orange" label="Orange">
    This is an orange 🍊
  </TabItem>
  <TabItem value="banana" label="Banana">
    This is a banana 🍌
  </TabItem>
</Tabs>

This is an apple 🍎