Skip to content

Introduction to Markdown

Hi there! In this workshop, we will be covering the basics of notetaking and how to efficiently take digital notes using Markdown format.

(PS: This document was written with Markdown ❤)

Organized by Ahmed Thahir

Recording

Watch the Recording

Usage

We will be using open-source editor Marktext for this workshop. You may download the latest version from its Releases Page.

Notetaking

Definition

Note-taking is the practice of recording information from different sources and platforms. By taking notes, the writer records the essence of the information, freeing their mind from having to recall everything.

Purpose

Notetaking allows us to capture information and help make sense of it. Our current world has so much information out there that it can be hard to store all that in our memory.

Notetaking helps eliminate the clutter and focus on what is important.

Markdown

Markdown is a lightweight markup language for creating formatted text using a plain-text editor … a markup language that is appealing to human readers in its source code form. Markdown is widely used in blogging, instant messaging, online forums, collaborative software, documentation pages, and readme files.

  • Markdown allows notetakers to collect and store notes in plain-text
  • It allows to avoid proprietary software, by taking notes in an open-source format
  • It allows to focus on the content, as
  • the content is separated from the styling settings
  • notetaker does not use buttons, but rather uses #, ##, - to denote different headers, sub-headers, lists, etc.

Headers

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

Paragraph

example

Emphasis

*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
*You **can** combine them*

This text will be italic

This will also be italic

This text will be bold

This will also be bold

You can combine them

Lists

Unordered

- Item 1
- Item 2
  - Item 2a
  - Item 2b

(or)

* Item 1
* Item 2
  * Item 2a
  * Item 2b
  • Item 1
  • Item 2
  • Item 2a
  • Item 2b

Ordered

1. Item 1
2. Item 2
3. Item 3
    1. Item 3a
    2. Item 3b
  1. Item 1
  2. Item 2
  3. Item 3
    1. Item 3a
    2. Item 3b

Tasks

- [x] Completed item
- [ ] Incomplete item
  • Completed item
  • Incomplete item

Images

![Alt Text](url)

Local Image
![GitHub Logo](logo.png)

Web Image
![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png)

GitHub Logo

Unlabelled Links
http://github.com - automatic!

Labelled Links
[GitHub](http://github.com)

GitHub

Code Fences

```python
print("Hello World")
```

print("Hello World")

Tables

|       | Column 1 | Column 2 |
| ----- | -------- | -------- |
| Row 1 |          |          |
| Row 2 |          |          |
Column 1 Column 2
Row 1
Row 2

Diagrams

flowchart LR
a --> b & c -.-> d

flowchart LR
a --> b & c -.-> d

Math

This is inline $x^2$

This is a block equation

$$
\int_0^\infty x^2
$$

This is inline \(x^2\)

This is a block equation

\[ \int_0^\infty x^2 \]