Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
discussion:playground:playground [2019/01/23 14:47] – v0tti | discussion:playground:playground [2019/01/23 14:59] (current) – v0tti | ||
---|---|---|---|
Line 6: | Line 6: | ||
**CodiMD** is a real-time, multi-platform collaborative markdown note editor. | **CodiMD** is a real-time, multi-platform collaborative markdown note editor. | ||
This means that you can write notes with other people on your **desktop**, | This means that you can write notes with other people on your **desktop**, | ||
- | You can sign-in via multiple auth providers like **Facebook**, | + | You can sign-in via multiple auth providers like **Facebook**, |
- | If you experience any _issues_, feel free to report it on [**GitHub**](https:// | + | If you experience any _issues_, feel free to report it on **[GitHub](https:// |
- | Or meet us on [**Matrix.org**](https:// | + | Or meet us on **[Matrix.org](https:// |
**Thank you very much!** | **Thank you very much!** | ||
- | Workspace | + | {{tablelayout? |
- | === | + | ^ test ^ 2 ^ |
- | ## Modes | + | | 3 | 4 | |
- | **Desktop & Tablet** | + | |
- | + | ||
- | <i class=" | + | |
- | <i class=" | + | |
- | <i class=" | + | |
- | + | ||
- | **Mobile** | + | |
- | + | ||
- | <i class=" | + | |
- | <i class=" | + | |
- | + | ||
- | ## Night Mode: | + | |
- | When you are tired of a white screen and like a night mode, click on the little moon <i class=" | + | |
- | + | ||
- | The editor view, which is in night mode by default, can also be toggled between night and day view using the the little sun<i class=" | + | |
- | + | ||
- | ## Image Upload: | + | |
- | You can upload an image simply by clicking on the camera button <i class=" | + | |
- | Alternatively, | + | |
- | This will automatically upload the image to **[imgur](http:// | + | |
- |  | + | |
- | - emacs | + | |
- | - vim | + | |
- | + | ||
- | ## Shortcut Keys: | + | |
- | The shortcut keys depend on your selected editor mode. By default they are just like Sublime text, which is pretty quick and convenient. | + | |
- | > For more information, | + | |
- | + | ||
- | For emacs: | + | |
- | > For more information, | + | |
- | + | ||
- | For vim: | + | |
- | > For more information, | + | |
- | + | ||
- | ## Auto-Complete: | + | |
- | This editor provides full auto-complete hints in markdown. | + | |
- | - Emojis: type `:` to show hints. | + | |
- | - Code blocks: type ` ``` ` and plus a character to show hint. <i hidden> | + | |
- | - Headers: type `#` to show hint. | + | |
- | - Referrals: type `[]` to show hint. | + | |
- | - Externals: type `{}` to show hint. | + | |
- | - Images: type `!` to show hint. | + | |
- | + | ||
- | ## Title: | + | |
- | This will take the first **level 1 header** as the note title. | + | |
- | + | ||
- | ## Tags: | + | |
- | Using tags as follows, the specified tags will show in your **history**. | + | |
- | ###### tags: `features` `cool` `updated` | + | |
- | + | ||
- | ## [YAML Metadata](./ | + | |
- | You can provide advanced note information to set the browser behavior (visit above link for details): | + | |
- | - robots: set web robots meta | + | |
- | - lang: set browser language | + | |
- | - dir: set text direction | + | |
- | - breaks: set to use line breaks | + | |
- | - GA: set to use Google Analytics | + | |
- | - disqus: set to use Disqus | + | |
- | - slideOptions: | + | |
- | + | ||
- | ## ToC: | + | |
- | Use the syntax `[TOC]` to embed table of content into your note. | + | |
- | + | ||
- | [TOC] | + | |
- | + | ||
- | ## Emoji | + | |
- | You can type any emoji like this :smile: :smiley: :cry: :wink: | + | |
- | > See full emoji list [here](http:// | + | |
- | + | ||
- | ## ToDo List: | + | |
- | - [ ] ToDos | + | |
- | - [x] Buy some salad | + | |
- | - [ ] Brush teeth | + | |
- | - [x] Drink some water | + | |
- | + | ||
- | ## Code Block: | + | |
- | We support many programming languages, use the auto complete function to see the entire list. | + | |
- | ```javascript= | + | |
- | var s = " | + | |
- | alert(s); | + | |
- | function $initHighlight(block, | + | |
- | try { | + | |
- | if (cls.search(/ | + | |
- | return process(block, | + | |
- | ' | + | |
- | | + | |
- | /* handle exception */ | + | |
- | | + | |
- | | + | |
- | if (checkCondition(classes[i]) === undefined) | + | |
- | return / | + | |
- | } | + | |
- | } | + | |
- | ``` | + | |
- | > If you want **line numbers**, type `=` after specifying the code block languagues. | + | |
- | > Also, you can specify the start line number. | + | |
- | > Like below, the line number starts from 101: | + | |
- | ```javascript=101 | + | |
- | var s = " | + | |
- | alert(s); | + | |
- | function $initHighlight(block, | + | |
- | try { | + | |
- | if (cls.search(/ | + | |
- | return process(block, | + | |
- | ' | + | |
- | } catch (e) { | + | |
- | /* handle exception */ | + | |
- | } | + | |
- | for (var i = 0 / 2; i < classes.length; | + | |
- | if (checkCondition(classes[i]) === undefined) | + | |
- | return / | + | |
- | } | + | |
- | } | + | |
- | ``` | + | |
- | + | ||
- | > Or you might want to continue the previous code block' | + | |
- | + | ||
- | ```javascript=+ | + | |
- | var s = " | + | |
- | alert(s); | + | |
- | ``` | + | |
- | + | ||
- | > Somtimes you have a super long text without breaks. It's time to use `!` to wrap your code. | + | |
- | + | ||
- | ```! | + | |
- | When you’re a carpenter making a beautiful chest of drawers, you’re not going to use a piece of plywood on the back. | + | |
- | ``` | + | |
- | + | ||
- | ### Blockquote Tags: | + | |
- | > Using the syntax below to specifiy your **name, time and color** to vary the blockquotes. | + | |
- | > [name=ChengHan Wu] [time=Sun, Jun 28, 2015 9:59 PM] [color=# | + | |
- | > > Even support the nest blockquotes! | + | |
- | > > [name=ChengHan Wu] [time=Sun, Jun 28, 2015 10:00 PM] [color=red] | + | |
- | + | ||
- | ## Externals | + | |
- | + | ||
- | ### YouTube | + | |
- | {%youtube aqz-KE-bpKQ %} | + | |
- | + | ||
- | ### Vimeo | + | |
- | {%vimeo 124148255 %} | + | |
- | + | ||
- | ### Gist | + | |
- | {%gist schacon/ | + | |
- | + | ||
- | ### SlideShare | + | |
- | {%slideshare briansolis/ | + | |
- | + | ||
- | ### Speakerdeck | + | |
- | {%speakerdeck sugarenia/ | + | |
- | + | ||
- | + | ||
- | **Caution: this might be blocked by your browser if not using an `https` URL.** | + | |
- | {%pdf https:// | + | |
- | + | ||
- | ## MathJax | + | |
- | + | ||
- | You can render *LaTeX* mathematical expressions using **MathJax**, | + | |
- | + | ||
- | The *Gamma function* satisfying $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ is via the Euler integral | + | |
- | + | ||
- | $$ | + | |
- | x = {-b \pm \sqrt{b^2-4ac} \over 2a}. | + | |
- | $$ | + | |
- | + | ||
- | $$ | + | |
- | \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\, | + | |
- | $$ | + | |
- | + | ||
- | > More information about **LaTeX** mathematical expressions [here](http:// | + | |
- | + | ||
- | ## UML Diagrams | + | |
- | + | ||
- | ### Sequence Diagrams | + | |
- | + | ||
- | You can render sequence diagrams like this: | + | |
- | + | ||
- | ```sequence | + | |
- | Alice-> | + | |
- | Note right of Bob: Bob thinks | + | |
- | Bob--> | + | |
- | Note left of Alice: Alice responds | + | |
- | Alice-> | + | |
- | ``` | + | |
- | + | ||
- | ### Flow Charts | + | |
- | + | ||
- | Flow charts can be specified like this: | + | |
- | ```flow | + | |
- | st=> | + | |
- | e=>end: End | + | |
- | op=> | + | |
- | op2=> | + | |
- | cond=> | + | |
- | + | ||
- | st-> | + | |
- | cond(yes)-> | + | |
- | cond(no)-> | + | |
- | ``` | + | |
- | + | ||
- | ### Graphviz | + | |
- | ```graphviz | + | |
- | digraph hierarchy { | + | |
- | + | ||
- | nodesep=1.0 // increases the separation between nodes | + | |
- | + | ||
- | node [color=Red, | + | |
- | edge [color=Blue, | + | |
- | + | ||
- | Headteacher-> | + | |
- | Deputy1-> | + | |
- | BusinessManager-> | + | |
- | {rank=same; | + | |
- | } | + | |
- | ``` | + | |
- | + | ||
- | ### Mermaid | + | |
- | ```mermaid | + | |
- | gantt | + | |
- | title A Gantt Diagram | + | |
- | + | ||
- | section Section | + | |
- | A task :a1, 2014-01-01, 30d | + | |
- | Another task | + | |
- | section Another | + | |
- | Task in sec : | + | |
- | anther task : 24d | + | |
- | ``` | + | |
- | + | ||
- | ### Abc | + | |
- | ```abc | + | |
- | X:1 | + | |
- | T:Speed the Plough | + | |
- | M:4/4 | + | |
- | C:Trad. | + | |
- | K:G | + | |
- | |:GABc dedB|dedB dedB|c2ec B2dB|c2A2 A2BA| | + | |
- | GABc dedB|dedB dedB|c2ec B2dB|A2F2 G4:| | + | |
- | |:g2gf gdBd|g2f2 e2d2|c2ec B2dB|c2A2 A2df| | + | |
- | g2gf g2Bd|g2f2 e2d2|c2ec B2dB|A2F2 G4:| | + | |
- | ``` | + | |
- | + | ||
- | > More information about **sequence diagrams** syntax [here](http:// | + | |
- | > More information about **flow charts** syntax [here](http:// | + | |
- | > More information about **graphviz** syntax [here](http:// | + | |
- | > More information about **mermaid** syntax [here](http:// | + | |
- | > More information about **abc** syntax [here](http:// | + | |
- | + | ||
- | Alert Area | + | |
- | --- | + | |
- | ::: | + | |
- | Yes :tada: | + | |
- | ::: | + | |
- | + | ||
- | :::info | + | |
- | This is a message :mega: | + | |
- | ::: | + | |
- | + | ||
- | ::: | + | |
- | Watch out :zap: | + | |
- | ::: | + | |
- | + | ||
- | :::danger | + | |
- | Oh No! :fire: | + | |
- | ::: | + | |
- | + | ||
- | ## Typography | + | |
- | + | ||
- | ### Headers | + | |
- | + | ||
- | ``` | + | |
- | # h1 Heading | + | |
- | ## h2 Heading | + | |
- | ### h3 Heading | + | |
- | #### h4 Heading | + | |
- | ##### h5 Heading | + | |
- | ###### h6 Heading | + | |
- | ``` | + | |
- | + | ||
- | ### Horizontal Rules | + | |
- | + | ||
- | ___ | + | |
- | + | ||
- | --- | + | |
- | + | ||
- | *** | + | |
- | + | ||
- | + | ||
- | ### Typographic Replacements | + | |
- | + | ||
- | Enable typographer option to see result. | + | |
- | + | ||
- | (c) (C) (r) (R) (tm) (TM) (p) (P) +- | + | |
- | + | ||
- | test.. test... test..... test?..... test!.... | + | |
- | + | ||
- | !!!!!! ???? ,, | + | |
- | + | ||
- | Remarkable -- awesome | + | |
- | + | ||
- | " | + | |
- | + | ||
- | ' | + | |
- | + | ||
- | ### Emphasis | + | |
- | + | ||
- | **This is bold text** | + | |
- | + | ||
- | __This is bold text__ | + | |
- | + | ||
- | *This is italic text* | + | |
- | + | ||
- | _This is italic text_ | + | |
- | + | ||
- | ~~Deleted text~~ | + | |
- | + | ||
- | lu~lala~ | + | |
- | + | ||
- | Superscript: | + | |
- | + | ||
- | Subscript: H~2~O | + | |
- | + | ||
- | ++Inserted text++ | + | |
- | + | ||
- | ==Marked text== | + | |
- | + | ||
- | + | ||
- | ### Blockquotes | + | |
- | + | ||
- | + | ||
- | > Blockquotes can also be nested... | + | |
- | >> ...by using additional greater-than signs right next to each other... | + | |
- | > > > ...or with spaces between arrows. | + | |
- | + | ||
- | + | ||
- | ### Lists | + | |
- | + | ||
- | #### Unordered | + | |
- | + | ||
- | + Create a list by starting a line with `+`, `-`, or `*` | + | |
- | + Sub-lists are made by indenting 2 spaces: | + | |
- | - Marker character change forces new list start: | + | |
- | * Ac tristique libero volutpat at | + | |
- | + Facilisis in pretium nisl aliquet | + | |
- | - Nulla volutpat aliquam velit | + | |
- | + Very easy! | + | |
- | + | ||
- | #### Ordered | + | |
- | + | ||
- | 1. Lorem ipsum dolor sit amet | + | |
- | 2. Consectetur adipiscing elit | + | |
- | 3. Integer molestie lorem at massa | + | |
- | + | ||
- | + | ||
- | 1. You can use sequential numbers... | + | |
- | 1. ...or keep all the numbers as `1.` | + | |
- | 1. feafw | + | |
- | 2. 332 | + | |
- | 3. 242 | + | |
- | 4. 2552 | + | |
- | 1. e2 | + | |
- | + | ||
- | Start numbering with offset: | + | |
- | + | ||
- | 57. foo | + | |
- | 1. bar | + | |
- | + | ||
- | ### Code | + | |
- | + | ||
- | Inline `code` | + | |
- | + | ||
- | Indented code | + | |
- | + | ||
- | // Some comments | + | |
- | line 1 of code | + | |
- | line 2 of code | + | |
- | line 3 of code | + | |
- | + | ||
- | + | ||
- | Block code " | + | |
- | + | ||
- | ``` | + | |
- | Sample text here... | + | |
- | ``` | + | |
- | + | ||
- | Syntax highlighting | + | |
- | + | ||
- | ``` js | + | |
- | var foo = function (bar) { | + | |
- | return bar++; | + | |
- | }; | + | |
- | + | ||
- | console.log(foo(5)); | + | |
- | ``` | + | |
- | + | ||
- | ### Tables | + | |
- | + | ||
- | | Option | Description | | + | |
- | | ------ | ----------- | | + | |
- | | data | path to data files to supply the data that will be passed into templates. | | + | |
- | | engine | engine to be used for processing templates. Handlebars is the default. | | + | |
- | | ext | extension to be used for dest files. | | + | |
- | + | ||
- | Right aligned columns | + | |
- | + | ||
- | | Option | Description | | + | |
- | | ------:| -----------: | + | |
- | | data | path to data files to supply the data that will be passed into templates. | | + | |
- | | engine | engine to be used for processing templates. Handlebars is the default. | | + | |
- | | ext | extension to be used for dest files. | | + | |
- | + | ||
- | Left aligned columns | + | |
- | + | ||
- | | Option | Description | | + | |
- | |:------ |: | + | |
- | | data | path to data files to supply the data that will be passed into templates. | | + | |
- | | engine | engine to be used for processing templates. Handlebars is the default. | | + | |
- | | ext | extension to be used for dest files. | | + | |
- | + | ||
- | Center aligned columns | + | |
- | + | ||
- | | Option | Description | | + | |
- | |: | + | |
- | | data | path to data files to supply the data that will be passed into templates. | | + | |
- | | engine | engine to be used for processing templates. Handlebars is the default. | | + | |
- | | ext | extension to be used for dest files. | | + | |
- | + | ||
- | + | ||
- | ### Links | + | |
- | [link text](http:// | + | |
- | [link with title](http:// | + | |
- | Autoconverted link https:// | + | |
- | + | ||
- | + | ||
- | ### Images | + | |
- | ![Minion](https:// | + | |
- | ![Stormtroopocat](https:// | + | |
- | Like links, Images also have a footnote style syntax | + | |
- | ![Alt text][id] | + | |
- | With a reference later in the document defining the URL location: | + | |
- | + | ||
- | [id]: https:// | + | |
- | + | ||
- | ![Minion](https:// | + | |
- | Show the image with given size | + | |
- | + | ||
- | ### Footnotes | + | |
- | + | ||
- | Footnote 1 link[^first]. | + | |
- | Footnote 2 link[^second]. | + | |
- | Inline footnote^[Text of inline footnote] definition. | + | |
- | Duplicated footnote reference[^second]. | + | |
- | + | ||
- | [^first]: Footnote **can have markup** | + | |
- | and multiple paragraphs. | + | |
- | [^second]: Footnote text. | + | |
- | + | ||
- | ### Definition Lists | + | |
- | + | ||
- | Term 1 | + | |
- | + | ||
- | : | + | |
- | with lazy continuation. | + | |
- | + | ||
- | Term 2 with *inline markup* | + | |
- | + | ||
- | : | + | |
- | + | ||
- | { some code, part of Definition 2 } | + | |
- | + | ||
- | Third paragraph of definition 2. | + | |
- | + | ||
- | _Compact style:_ | + | |
- | + | ||
- | Term 1 | + | |
- | ~ Definition 1 | + | |
- | + | ||
- | Term 2 | + | |
- | ~ Definition 2a | + | |
- | ~ Definition 2b | + | |
- | + | ||
- | ### Abbreviations | + | |
- | + | ||
- | This is an HTML abbreviation example. | + | |
- | It converts " | + | |
- | + | ||
- | *[HTML]: Hyper Text Markup Language | + |