Markdown guide FOR ATOM

• 測試一下github page與atom使用的markdown表現分別
• Latex, emoji無法使用(?)
  • :dizzy:
• toc不能用(?)

Atom Guide

• ctrl + shift + p 可以call terminal出黎
• Project Folder請唔好有中文or符號, Markdown Preview會睇唔到圖片
• 若然你只係想睇內容，最好用.htmlfiles會比較好睇 :)
• Btw, markdown主要都係作為文字記錄平台, 如果要畫圖/非文字媒體最好用其他software(e.g. powerpoint) 畫完再貼上黎會比較方便
• atom入面打i + tab = italic(自動出個斜線符號包住)，同理b+tab = bold
• File $\rightarrow$ Stylesheet 可以自己加css(改字體etc.)

必裝Packages

• Markdown preview enhanced
• Markdwon table editor
• Markdown image assistant

Table of Contents

[toc]

試下用link to section做:

1. General
2. Lists

General

1
2
3
4

# Header1
## Header2
### Header3
max = Header6

Italic1 Italic2 Bold1 Bold2 StrikThrough ==Highlight==

Lists

• unordered list
  • sublist

1. ordered list
   1. ordered list
   2. xx

• Task list
  • To-do list

Table

要裝Markdown table editor (atom)

• Tab: Next cell
• Enter: Next line
• Esc: Leave table edit mode

Link (HyperText)

GitHub

Image

• Note: 圖片要放static底下
• 或者放同一個page bundle入面 (即係有index.md的同一個folder底下)

Text Formatting

• Superscript: 1^st^
• Subscript: CO~2~
• Footnotes: Article ¹

Abbreviation:

• *[md]: markdown
• *[cool]: cool and beautiful
• md is cool

emoji: :smiley: :fa-flag: Cheatsheet: @import “assets\emoji_list.md”

Blockquote

Evil knows of the good,

But good does not know of the evil

Code Block

1
2
3
4
5
6
7

main()
{
  int i=0;
  while (1)
    break;
  end;
}

Maths

CheatSheet

Basics

$ x^5+y^{10} = {dy \over dx}2x$ $ \sqrt[4]{x} \not= \int \iint $

1
2
3

 \tag{equation 1}
 f(x,y)=sin(2\pi\theta)

$$ \tag{2.10} \sum_{n=1}^{100} e^n $$

$ \tilde{a}, \vec{F}, \bar{y}, \big(,\Big(, \bigg( ABCD \bigg) $

Matrix

1
2
3
4

\begin{matrix}
  a&b\\
  c&d
\end{matrix}

1
2
3
4

\begin{bmatrix}
  a&b\\
  c&d
\end{bmatrix}

1
2
3
4

\begin{vmatrix}
  a&b\\
  c&d
\end{vmatrix}

Alignments

1
2
3
4

x = \begin{cases}
   a &\text{if } b \\
   c &\text{if } d
\end{cases}

1
2
3
4
5
6

\begin{alignedat}{2}
   10&x+ &3&y = 2 \\
   3&x+&13&y = 4
\end{alignedat}

Greek Letters

$ \Delta \delta \phi \Phi$

Logics, Set Theory

Marcos

1
2

 \def\func{x^y}
 \func + \func \over \func

Diagrams

flow charts

1
2
3
4
5
6
7
8

st=>start: hello
e=>end: byebye
op=>operation: add a into b
cond=>condition: are you sure?

st->op->cond
cond(yes)->e
cond(no)->op

Import

Configure Image

@import “image.png” {width=“400px” height=“300px” title=“Hello” align=“Right”}

OR

Supported file types

Common:

• .jpeg(.jpg), .gif, .png
• .csv: converted to markdown table.
• .html: embeded directly
• .pdf: you need to download pdf2svg first

Presentation

Guide