# Welcome to Writer **Writer** is a delicate Markdown editor. It offers great writing experience with reliable local storage. - **Versatile** - supporting code highlight, *LaTeX* & flow charts, inserting images & attachments by all means. - **Exquisite** - neat but powerful editor, featuring offline docs and live preview. - **Local First** - all your notes are stored locally in your browser. ---------- [TOC] ## Introducing Markdown > Markdown is a plain text formatting syntax designed to be converted to HTML. Markdown is popularly used as format for readme files, ... or in text editors for the quick creation of rich text documents. - [Wikipedia](http://en.wikipedia.org/wiki/Markdown) As showed in this manual, it uses hash(#) to identify headings, emphasizes some text to be **bold** or *italic*. You can insert a [link](http://www.example.com) , or a footnote[^demo]. Serveral advanced syntax are listed below, please press `Ctrl + /` to view Markdown cheatsheet. ### Code block ``` python @requires_authorization def somefunc(param1='', param2=0): '''A docstring''' if param1 > param2: # interesting print 'Greater' return (param2 - param1 + 1) or None class SomeClass: pass >>> message = '''interpreter ... prompt''' ``` ### LaTeX expression $$ x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$ ### Table | Item | Value | Qty | | :-------- | --------:| :--: | | Computer | 1600 USD | 5 | | Phone | 12 USD | 12 | | Pipe | 1 USD | 234 | ### Diagrams #### Flow charts ```flow st=>start: Start e=>end op=>operation: My Operation cond=>condition: Yes or No? st->op->cond cond(yes)->e cond(no)->op ``` #### Sequence diagrams ```sequence Alice->Bob: Hello Bob, how are you? Note right of Bob: Bob thinks Bob-->Alice: I am good thanks! ``` > **Note:** You can find more information: > - about **Sequence diagrams** syntax [here][3], > - about **Flow charts** syntax [here][4]. ### Checkbox You can use `- [ ]` and `- [x]` to create checkboxes, for example: - [x] Item1 - [ ] Item2 - [ ] Item3 ## Shortcuts Help `Ctrl + /` Sync Doc `Ctrl + S` Create Doc `Ctrl + Alt + N` Maximize Editor `Ctrl + Enter` Preview Doc `Ctrl + Alt + Enter` Doc Management `Ctrl + O` Menu `Ctrl + M` Bold `Ctrl + B` Insert Image `Ctrl + G` Insert Link `Ctrl + L` Convert Heading `Ctrl + H` ## Credits **Noter** was first built upon [Dillinger][5], and the newest version is almost based on the awesome [StackEdit][6]. Acknowledgments to them and other incredible open source projects! ## Feedback & Bug Report - Twitter: [@gock2][7] - Email: <hustgock@gmail.com> ---------- Thank you for reading this manual. Enjoy your **Noter** journey! [^demo]: This is a demo footnote. Read the [MultiMarkdown Syntax Guide](https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide#footnotes) to learn more. [3]: http://bramp.github.io/js-sequence-diagrams/ [4]: http://adrai.github.io/flowchart.js/ [5]: http://dillinger.io [6]: http://stackedit.io [7]: https://twitter.com/gock2

*Italic*   **Bold**

[Alt](http://example.com)

![Alt](example.jpg)

Heading1        Heading2
========        --------

## Heading2     ###### Heading6

1. Numbered list    - Bulleted list
2. Numbered list    - Bulleted list

> This is quote content
> it can embed heading or list

Inline code `var a=1`,  code block:：
```ruby
print 'Hello world'
```

Inline $ y = x $ , block:：
$$ a^2 + b^2 = c^2 $$

| Item      |    Value | Qty  |
| :-------- | --------:| :--: |
| Computer  | 1600 USD |  5   |

![@desc | left | 300x0](a.jpg)