I am using the MWeb Lite tool, Mac version.
# Markdown Grammar and MWeb instructions for use of writing
# # Markdown Philosophy of Design
> Markdown's goal is "easy to read and easy to write".
> The most necessary thing is its accessibility. A document written in the Markdown format should be written directly in pure text, and will not look like a multi-label or format directive.
> Markdown's language has a major purpose: to use it as a Web-Lunejon * language.
<!--more--
## This article Conventions
If there is write ' effect as follows: ', in MWeb edit state only with ' CMD + R ' preview to see the effect.
## title
Markdown Syntax:
```
# First level headline '
# # Second Level title '
###### Sixth level title '
```
The effect is as follows:
# First Level title '
## Second Level title '
###### Sixth level title '
## emphasized
Markdown Syntax:
```
* These words will generate ' <em> ' *
_ These words will generate ' <u> ' _
* * These words will generate ' <strong> ' * *
__ These words will generate ' <strong> ' __
```
The shortcut keys in MWeb are: ' cmd + U ', ' cmd + I ', ' cmd + B '
The effect is as follows:
* These words will generate ' <em> ' *
_ These words will generate ' <u> ' _
** the text will generate ' <strong> ' * *
__ the text will generate ' <strong> ' __
## line Break
Four spaces plus a carriage return.
If you do not want to hit so many spaces, as long as the carriage return for the line, please tick: ' Preferences '-' Themes '-' Translate newlines to <br> tags '
## List
# # unordered List
Markdown Syntax:
```
* Item One unordered list ' * + Space key '
* Item Two
* Item two sub-item one unordered table ' TAB + * + SPACEBAR '
* Sub-item two of item two
```
The shortcut keys in MWeb are: ' Option + U '
The effect is as follows:
* Item One unordered list ' * + Space key '
* Item Two
* Item two sub-item one unordered table ' TAB + * + SPACEBAR '
* Sub-item two of item two
# # # Ordered List
Markdown Syntax:
```
1. Project an ordered list ' number + '. + Space key '
2. Item Two
3. Item Three
1. Project three sub-project an ordered list of ' TAB + number +. + Space key '
2. Sub-item two of item three
```
The effect is as follows:
1. Project an ordered list ' number + '. + Space key '
2. Item Two
3. Item Three
1. Project three sub-project an ordered list of ' TAB + number +. + Space key '
2. Sub-item two of item three
# # # Task List (task lists)
Markdown Syntax:
```
-[] Task one not doing task '-+ space + [] '
-[x] task two done task '-+ space + [x] '
```
The effect is as follows:
-[] Task one not doing task '-+ space + [] '
-[x] task two done task '-+ space + [x] '
## Image
Markdown Syntax:
```
! [GitHub set up] (http://zh.mweb.im/asset/img/set-up-git.gif)
Format:! [Alt Text] (URL)
```
' Control + Shift + I ' can insert markdown syntax.
If you are a document in a MWeb document library, you can also add images by dragging and dropping pictures, ' cmd + V ' paste, ' cmd + Option + I ' Import these three ways.
The effect is as follows:
! [GitHub set up] (http://zh.mweb.im/asset/img/set-up-git.gif)
## links
Markdown Syntax:
```
Email <[email protected]>
[GitHub] (http://github.com)
Automatically generate Connections
```
' Control + Shift + L ' can insert markdown syntax.
If it is a document in a MWeb document library, a connection is generated when drag-and-drop or ' CMD + Option + I ' imports a non-picture.
The effect is as follows:
Email Connection: <[email protected]>
[Connection title GitHub website] (http://github.com)
Automatically generated connections like this:
## Chunk Reference
Markdown Syntax:
```
xxx says:
> First Row reference
> Second line Fee text
```
' CMD + Shift + B ' can insert markdown syntax.
The effect is as follows:
xxx says:
> First Row reference
> Second line Fee text
## in-line code
Markdown Syntax:
```
Like this: ' <addr> ' code '
```
' CMD + K ' can insert markdown syntax.
The effect is as follows:
Like this: ' <addr> ' code '
## multiple lines or a section of code
Markdown Syntax:
"JS
function Fancyalert (ARG) {
if (ARG) {
$.facebox ({div: ' #foo '})
}
}
```
' CMD + Shift + K ' can be inserted into the markdown syntax.
The effect is as follows:
"JS
function Fancyalert (ARG) {
if (ARG) {
$.facebox ({div: ' #foo '})
}
}
```
## sequence diagram or flowchart
Markdown Syntax:
"' Sequence
Zhang San, John Doe: Hey, little four, do you have a blog?
Note right of John Doe: John Doe Leng A bit, said:
John Doe--Zhang San: too busy to spit blood, which has time to write.
```
"Flow
St=>start: Start
E=>end: End
Op=>operation: My actions
Cond=>condition: Confirmation?
St->op->cond
Cond (yes)->e
Cond (NO)->OP
```
The effect is as follows (' Preferences '-' Themes '-' Enable sequence & flow chart ' to see the effect):
"' Sequence
Zhang San, John Doe: Hey, little four, do you have a blog?
Note right of John Doe: John Doe Leng A bit, said:
John Doe--Zhang San: too busy to spit blood, which has time to write.
```
"Flow
St=>start: Start
E=>end: End
Op=>operation: My actions
Cond=>condition: Confirmation?
St->op->cond
Cond (yes)->e
Cond (NO)->OP
```
For more information, please refer to:
## Table
Markdown Syntax:
```
First table Header | Second-pane table header
--------- | -------------
Content cell first Column First grid | Content cell second column first grid
Content cell The first column second lattice more text | Content cell second column second grid
```
The effect is as follows:
First table Header | Second-pane table header
--------- | -------------
Content cell first Column First grid | Content cell second column first grid
Content cell The first column second lattice more text | Content cell second column second grid
## Delete Line
Markdown Syntax:
Add strikethrough like this use: ~ ~ Delete these ~ ~
The effect is as follows:
Add strikethrough like this use: ~ ~ Delete these ~ ~
## Divider Line
There are three ways to create a divider line:
***
*****
- - -
The effect is as follows:
***
*****
- - -
# # Mathjax
Markdown Syntax:
```
Block-level formula:
$$ x = \dfrac{-b \pm \sqrt{b^2-4ac}}{2a} $$
\\[\frac{1}{\bigl (\sqrt{\phi \sqrt{5}}-\phi\bigr) e^{\frac25 \pi}} =
1+\FRAC{E^{-2\PI}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots}}} } \\]
In-line formula: $\gamma (N) = (n-1)!\quad\forall n\in\mathbb n$
```
The effect is as follows (' Preferences '-' Themes '-' Enable mathjax ' to see the effect):
Block-level formula:
$$ x = \dfrac{-b \pm \sqrt{b^2-4ac}}{2a} $$
\\[\frac{1}{\bigl (\sqrt{\phi \sqrt{5}}-\phi\bigr) e^{\frac25 \pi}} =
1+\FRAC{E^{-2\PI}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots}}} } \\]
In-line formula: $\gamma (N) = (n-1)!\quad\forall n\in\mathbb n$
## Footnotes ( Footnote )
Markdown Syntax:
```
This is a footnote: [^sample_footnote]
```
The effect is as follows:
This is a footnote: [^sample_footnote]
[^sample_footnote]: Here is the footnote information
## comment and read more
<!--Comment--
<!--more--
Actions->insert Read more Comment * or * ' Command +. '
** Note * * Read more features only when building a website or blog.
# # TOC
Markdown Syntax:
```
[TOC]
```
The effect is as follows:
[TOC]
Markdown Grammar and MWeb writing instruction (personal retention)