Markdown

MarkdowMarkdown is a lightweight markup language for creating formatted text using a plain-text editor. It’s widely used for documentation, websites, notes, and more due to its simplicity and readability.

Author

Benedict Thekkel

1. Basic Text Formatting

Bold

**This is bold text**
__This is bold text__

This is bold text

Italic

*This is italic text*
_This is italic text_

This is italic text

Bold and Italic

***This is bold and italic***
___This is bold and italic___

This is bold and italic

Strikethrough

~~This text is struck through~~

~~This text is struck through~~

2. Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Heading 3

Heading 4

Heading 5

Heading 6

3. Lists

Ordered List

1. First item
2. Second item
   1. Sub-item
   2. Sub-item
3. Third item

First item
Second item
1. Sub-item
2. Sub-item
Third item

Unordered List

- First item
- Second item
  - Sub-item
  - Sub-item
- Third item

First item
Second item
- Sub-item
- Sub-item
Third item

4. Links

[Clickable text](https://example.com)

Clickable text

Reference-style Links

[Clickable text][1]

[1]: https://example.com

5. Images

![Alt text](https://example.com/image.png)

6. Code

Inline Code

`Inline code`

Inline code

Code Block

Code block

For specific languages:

\```python
print("Hello, World!")
\```

7. Blockquotes

> This is a blockquote
>> Nested blockquote

This is a blockquote
> Nested blockquote

9. Tables

| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Value 1  | Value 2  | Value 3  |
| Value A  | Value B  | Value C  |

Column 1	Column 2	Column 3
Value 1	Value 2	Value 3
Value A	Value B	Value C

Table 1: Main Caption

(a) First Table

Col1	Col2	Col3
A	B	C
E	F	G
A	G	G

(b) Second Table

Col1	Col2	Col3
A	B	C
E	F	G
A	G	G

10. Task Lists

- [x] Completed task
- [ ] Incomplete task

Completed task
Incomplete task

11. Escaping Characters

To include Markdown characters as literal text, use a backslash (\):

\*Literal asterisk\*

*Literal asterisk*

12. Advanced Syntax

Footnotes

This is a sentence with a footnote.[^1]

[^1]: This is the footnote text.

This is a sentence with a footnote.¹

Definition Lists

Term 1
: Definition 1

Term 2
: Definition 2

Term 1: Definition 1
Term 2: Definition 2

13. HTML in Markdown

You can include raw HTML for additional formatting:

<div style="color: blue;">This text is blue</div>

This text is blue

14. Extensions

Many Markdown processors support extended syntax: - Math (e.g., LaTeX): markdown $$E = mc^2$$ (E = mc^2)

Mermaid Diagrams:
```
```mermaid
graph TD;
    A-->B;
```
```

15. Diagrams

flowchart LR
  A[Hard edge] --> B(Round edge)
  B --> C{Decision}
  C --> D[Result one]
  C --> E[Result two]

16. Callouts

Note

Note that there are five types of callouts, including: note, warning, important, tip, and caution.

Tip with Title

This is an example of a callout with a title.

Expand To Learn About Collapse

This is an example of a ‘folded’ caution callout that can be expanded by the user. You can use collapse="true" to collapse it by default or collapse="false" to make a collapsible callout that is expanded by default.

Shortcuts and Tricks

Command Mode Shortcuts

There are a couple of useful keyboard shortcuts in Command Mode that you can leverage to make Jupyter Notebook faster to use. Remember that you can switch back and forth between Command Mode and Edit Mode with Esc and Enter.

m:: Convert cell to Markdown
y:: Convert cell to Code
d+d:: Delete cell
o:: Toggle between hide or show output
Shift+Arrow up/Arrow down:: Select multiple cells. Once you have selected them you can operate on them like a batch (run, copy, paste etc).
Shift+M:: Merge selected cells

Cell Tricks

There are also some tricks that you can code into a cell:

?function-name:: Shows the definition and docstring for that function
??function-name:: Shows the source code for that function
doc(function-name):: Shows the definition, docstring and links to the documentation of the function (only works with fastai library imported)
Shift+Tab (press once):: See which parameters to pass to a function
Shift+Tab (press three times):: Get additional information on the method

Here’s an example of using ? to learn about Python’s print() function:

Footnotes

This is the footnote text.↩︎