|
| 1 | +createdAt: "2019-06-26T13:12:08.057Z" |
| 2 | +updatedAt: "2019-06-26T13:12:39.760Z" |
| 3 | +type: "MARKDOWN_NOTE" |
| 4 | +folder: "4bfaf976594ec1b5be18" |
| 5 | +title: "Short Introduction about Markdown" |
| 6 | +tags: [] |
| 7 | +content: ''' |
| 8 | + # Short Introduction about Markdown |
| 9 | + |
| 10 | + The Markdown language was created in 2004 by John Gruber with substantial contributions from Aaron Swartz, with the goal of allowing people “to write using an easy-to-read, easy-to-write plain text format, and optionally convert it to structurally valid XHTML (or HTML)”. |
| 11 | + |
| 12 | + Taking cues from existing conventions for marking up plain text in email such as setext, the language was designed to be readable as-is, without looking like it's been marked up with tags or formatting instructions, unlike text which has been formatted with a Markup language, such as HTML, which has obvious tags and formatting instructions. Markdown is a formatting syntax for text that can be read by humans and can be easily converted to HTML. |
| 13 | + |
| 14 | + Gruber wrote a Perl script, Markdown.pl, which converts marked-up text input to valid, well-formed XHTML or HTML and replaces left-pointing angle brackets ('<') and ampersands with their corresponding character entity references. It can be used as a standalone script, as a plugin for Blosxom or Movable Type, or as a text filter for BBEdit. |
| 15 | + |
| 16 | + Markdown has since been re-implemented by others as a Perl module available on CPAN (Text::Markdown), and in a variety of other programming languages. It is distributed under a BSD-style license and is included with, or available as a plugin for, several content-management systems. |
| 17 | + |
| 18 | + ### Use Cases |
| 19 | + |
| 20 | + Markdown is used in **GitHub**, **GitBook**, **Reddit**, **Diaspora**, **Stack Overflow**, **OpenStreetMap**, and many others. |
| 21 | + |
| 22 | + Even this book is written using Markdown: [Raw content of this page](https://raw.githubusercontent.com/GitbookIO/markdown/master/about/README.md). |
| 23 | + |
| 24 | + ### Files |
| 25 | + |
| 26 | + A markdown document is a text file with the `.md` extension. You can open a markdown file using a simple text editor. |
| 27 | + |
| 28 | + # Titles |
| 29 | + |
| 30 | + As we started writing a markdown document, we need to add a title and some sub-headers. |
| 31 | + |
| 32 | + Markdown supports two styles of headers, Setext and atx. |
| 33 | + |
| 34 | + Setext-style headers are “underlined” using equal signs (for first-level headers) and dashes (for second-level headers). For example: |
| 35 | + |
| 36 | + ``` |
| 37 | + This is an H1 |
| 38 | + ============= |
| 39 | + |
| 40 | + This is an H2 |
| 41 | + ------------- |
| 42 | + ``` |
| 43 | + |
| 44 | + Any number of underlining =’s or -’s will work. |
| 45 | + |
| 46 | + Atx-style headers use 1-6 hash characters at the start of the line, corresponding to header levels 1-6. For example: |
| 47 | + |
| 48 | + ``` |
| 49 | + # This is an H1 |
| 50 | + |
| 51 | + ## This is an H2 |
| 52 | + |
| 53 | + ###### This is an H6 |
| 54 | + ``` |
| 55 | + |
| 56 | + |
| 57 | + Optionally, you may “close” atx-style headers. This is purely cosmetic — you can use this if you think it looks better. The closing hashes don’t even need to match the number of hashes used to open the header. (The number of opening hashes determines the header level.) : |
| 58 | + |
| 59 | + ``` |
| 60 | + # This is an H1 # |
| 61 | + |
| 62 | + ## This is an H2 ## |
| 63 | + |
| 64 | + ### This is an H3 ###### |
| 65 | + ``` |
| 66 | + |
| 67 | + |
| 68 | + --- |
| 69 | + |
| 70 | + Here's a quiz about markdown titles. |
| 71 | + |
| 72 | + Select the valid headers: |
| 73 | + - [x] `# hello` |
| 74 | + - [ ] `#hello` |
| 75 | + |
| 76 | + > Headers need space between the hash characters and the text. |
| 77 | + |
| 78 | + Select the valid headers: |
| 79 | + - [ ] |
| 80 | + ``` |
| 81 | + test |
| 82 | + ######## |
| 83 | + ``` |
| 84 | + - [x] |
| 85 | + ``` |
| 86 | + test |
| 87 | + ======= |
| 88 | + ``` |
| 89 | + |
| 90 | + > Only '=' and '-' are accepted for underlining an header. |
| 91 | + |
| 92 | + --- |
| 93 | + # Images |
| 94 | + |
| 95 | + ```markdown |
| 96 | + # Inline |
| 97 | +  |
| 98 | + |
| 99 | + # Reference |
| 100 | + ![Alternative text][id] |
| 101 | + [id]: url/to/image "Optional title" |
| 102 | + ``` |
| 103 | + As you may have noticed, images in Markdown are very similar to links. The difference is that: |
| 104 | + * the square brackets must be prefixed with an exclamation mark and |
| 105 | + * inside they may have some alternative text. A description of the image, which is displayed if the image can't be loaded. |
| 106 | + |
| 107 | + --- |
| 108 | + |
| 109 | + Here's a quiz about markdown images. |
| 110 | + |
| 111 | + Select the valid images: |
| 112 | + - [ ] `[Google logo](https://www.google.ru/logo.png)` |
| 113 | + - [x] `` |
| 114 | + |
| 115 | + > Images must be prefixed with an exclamation mark. |
| 116 | + The alternative text and a title are optional. |
| 117 | + |
| 118 | + What is true about the following line: `````` |
| 119 | + - [x] if the url is 404, "Funny cat" will be displayed |
| 120 | + - [ ] exclamation mark can be omitted in this case |
| 121 | + - [ ] if the url is 404, "Share this" will be displayed |
| 122 | + - [x] on mouse over the image "Share this" will be displayed |
| 123 | + |
| 124 | + > Similarly to links, images can have 3 parts: the alternative text, the url and a title. An exclamation mark is nesessary. |
| 125 | + |
| 126 | + --- |
| 127 | + |
| 128 | +''' |
| 129 | +linesHighlighted: [] |
| 130 | +isStarred: false |
| 131 | +isTrashed: false |