How to write markdown (.md)

Markdown is a lightweight markup language with plain text formatting syntax. https://en.wikipedia.org/wiki/Markdown

Header line is used to specify chapter etc. 1 # shows top level header, 2 ## shows next level and so on.

Top level header

2ne level header

3rd level

4th

5th....

Emphasize and italic

In order to emphasize some words, quatate the words with ** or __.

If the words are enclosed with single * or _, it will become italic.

Code and code block

If the words are enclosed with back ticks (`), it will treated as a code (command). In order to imbed several lines of code, Triple back tiks are used. Formmatting of markdown is not performed in the code or code blocks. For example **this is not emphasized**.

# Python Hello world program
print('Hello world')

List

  • Unordered list can be written with either -, + or *.

    • this is a sample of unnumbered list line 1
    • line 2
    • line 3
  • Ordered List can be written iwth 1. ... which is automatically renumbered so only 1. is enough.

    1. Blank like is required before and after List
    2. Space is required after list header character(s)
  • HTML <dl> tag can be used as well

Apple
Red
Banana
Yellow
Cherry
Orange or Red

Blockquates

In order to display quated(copied) contents, > can be used.

John Gruber created the Markdown language in 2004 in collaboration with Aaron Swartz on the syntax,[3][4] with the goal of enabling people "to write using an easy-to-read, easy-to-write plain text format, and optionally convert it to structurally valid XHTML (or HTML)".[5]

(From wikipedia)

URL link can be written with either [site name](URL) or <URL>. For example.

Image

Image file such as JPG or PNG can be embedded with ![description](URL). For example

Mathematical formula

$\LaTeX$ (LaTex) mathematical rendering is supported in jupyter notebook.

There are several ways to do this

  • Enclose with $ to imbed formula in the text line. $\sqrt{x^2+y^2}$ is a distance from (0,0) to (x,y)
$$ (\int^{b}_{a} f(x) dx = \lim_{n \to \infty} \sum^{n-1}_{i=0} f(x_{i}) \Delta x $$\begin{align} \sqrt{a+b} \end{align}\begin{equation} H← ​​​60 ​+​ \frac{​​30(B−R)​​}{Vmax−Vmin} ​​, if V​max​​ = G \end{equation}

Graph

There are several ways to draw graph in jupyter notebook. Matplotlib is one of them.


In [ ]:
%matplotlib inline
import matplotlib.pyplot as plt
import numpy as np
import math

x = np.linspace(0, math.pi*2, 100)
y = np.sin(x)
plt.plot(x, y)