├── .gitignore ├── LICENSE ├── README.md ├── SUMMARY.md ├── about └── README.md ├── assets └── preview.png └── syntax ├── code.md ├── images.md ├── links.md ├── tables.md └── titles.md /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .grunt 3 | /_book/ 4 | .vscode 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2014 FriendCode Inc. 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Learn Markdown 2 | 3 | You may have heard about Markdown, if you have it's a good thing. 4 | 5 | Markdown is a plain text formatting syntax designed so that it can optionally be converted to HTML. 6 | 7 | In this book, you'll learn how to write document using the markdown syntax. 8 | 9 | ![Example of markdown with associated output document on the right](./assets/preview.png) 10 | -------------------------------------------------------------------------------- /SUMMARY.md: -------------------------------------------------------------------------------- 1 | # Summary 2 | 3 | - [About Markdown](about/README.md) 4 | - [Titles](syntax/titles.md) 5 | - [Links](syntax/links.md) 6 | - [Images](syntax/images.md) 7 | - [Code Blocks](syntax/code.md) 8 | - [Tables](syntax/tables.md) 9 | -------------------------------------------------------------------------------- /about/README.md: -------------------------------------------------------------------------------- 1 | # Short Introduction about Markdown 2 | 3 | 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)”. 4 | 5 | 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. 6 | 7 | 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. 8 | 9 | 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. 10 | 11 | ### Use Cases 12 | 13 | Markdown is used in **GitHub**, **GitBook**, **Reddit**, **Diaspora**, **Stack Overflow**, **OpenStreetMap**, and many others. 14 | 15 | Even this book is written using Markdown: [Raw content of this page](https://raw.githubusercontent.com/GitbookIO/markdown/master/about/README.md). 16 | 17 | ### Files 18 | 19 | A markdown document is a text file with the `.md` extension. You can open a markdown file using a simple text editor. 20 | -------------------------------------------------------------------------------- /assets/preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/GitbookIO/markdown/368a1bb25b0f0d1f11339b602d250baab7b6b713/assets/preview.png -------------------------------------------------------------------------------- /syntax/code.md: -------------------------------------------------------------------------------- 1 | # Code Blocks 2 | 3 | Pre-formatted code blocks are used for writing about programming or markup source code. Rather than forming normal paragraphs, the lines of a code block are interpreted literally. 4 | 5 | Here is an example: 6 | 7 | ```markdown 8 | This is a code block 9 | ``` 10 | 11 | To produce a code block in Markdown, simply indent every line of the block by at least 4 spaces or 1 tab. 12 | 13 | For example: 14 | 15 | ```markdown 16 | This is a normal paragraph: 17 | 18 | This is a code block. 19 | ``` 20 | 21 | You can also create code block separated by: 22 | 23 | ``` 24 | 25 | ### Inline code blocks 26 | 27 | Inline code blocks can be written using: ` 28 | 29 | For example: 30 | 31 | This is a `inline code block` 32 | 33 | ### Syntax highlighting 34 | 35 | You can define the language to be used for syntax highlighting by adding the name on the opening tag. Example: 36 | 37 | ```javascript 38 | var a = {}; 39 | ``` 40 | -------------------------------------------------------------------------------- /syntax/images.md: -------------------------------------------------------------------------------- 1 | # Images 2 | 3 | ```markdown 4 | # Inline 5 | 6 | ![Alternative text](/path/to/img.jpg "Optional title") 7 | 8 | # Reference 9 | 10 | ![Alternative text][id] 11 | [id]: url/to/image "Optional title" 12 | ``` 13 | 14 | As you may have noticed, images in Markdown are very similar to links. The difference is that: 15 | 16 | - the square brackets must be prefixed with an exclamation mark and 17 | - inside they may have some alternative text. A description of the image, which is displayed if the image can't be loaded. 18 | -------------------------------------------------------------------------------- /syntax/links.md: -------------------------------------------------------------------------------- 1 | # Links 2 | 3 | Markdown supports two styles of links: inline and reference. 4 | 5 | In both styles, the link text is delimited by [square brackets]. 6 | 7 | To create an inline link, use a set of regular parentheses immediately after the link text’s closing square bracket. Inside the parentheses, put the URL where you want the link to point, along with an optional title for the link, surrounded in quotes. For example: 8 | 9 | ```markdown 10 | [I'm an inline-style link](https://www.google.com) 11 | 12 | [I'm an inline-style link with title](https://www.google.com "Google's Homepage") 13 | 14 | [I'm a reference-style link][arbitrary case-insensitive reference text] 15 | 16 | [I'm a relative reference to a repository file](../blob/master/LICENSE) 17 | ``` 18 | 19 | Reference-style links use a second set of square brackets, inside which you place a label of your choosing to identify the link: 20 | 21 | ```markdown 22 | This is [an example][id] reference-style link. 23 | ``` 24 | 25 | You can optionally use a space to separate the sets of brackets: 26 | 27 | ```markdown 28 | This is [an example] [id] reference-style link. 29 | ``` 30 | 31 | Then, anywhere in the document, you define your link label like this, on a line by itself: 32 | 33 | ```markdown 34 | [id]: http://example.com/ "Optional Title Here" 35 | ``` 36 | 37 | **GitHub** and **GitBook** supports URL autolinking. They will autolink standard URLs, so if you want to link to a URL (instead of setting link text), you can simply enter the URL and it will be turned into a link to that URL. 38 | -------------------------------------------------------------------------------- /syntax/tables.md: -------------------------------------------------------------------------------- 1 | # Tables 2 | 3 | Tables aren't part of the core Markdown spec, but they are part of GFM (GitHub Markdown) and Markdown Here supports them. 4 | 5 | Here is an example of table with the output below: 6 | 7 | ``` 8 | | Tables | Are | Cool | 9 | | ------------- |:-------------:| -----:| 10 | | col 3 is | right-aligned | $1600 | 11 | | col 2 is | centered | $12 | 12 | | zebra stripes | are neat | $1 | 13 | ``` 14 | 15 | | Tables | Are | Cool | 16 | | ------------- | :-----------: | ----: | 17 | | col 3 is | right-aligned | $1600 | 18 | | col 2 is | centered | $12 | 19 | | zebra stripes | are neat | $1 | 20 | 21 | Colons can be used to align columns. 22 | 23 | The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown. 24 | 25 | Example: 26 | 27 | ``` 28 | Markdown | Less | Pretty 29 | --- | --- | --- 30 | *Still* | `renders` | **nicely** 31 | 1 | 2 | 3 32 | ``` 33 | -------------------------------------------------------------------------------- /syntax/titles.md: -------------------------------------------------------------------------------- 1 | # Titles 2 | 3 | As we started writing a markdown document, we need to add a title and some sub-headers. 4 | 5 | Markdown supports two styles of headers, Setext and atx. 6 | 7 | Setext-style headers are “underlined” using equal signs (for first-level headers) and dashes (for second-level headers). For example: 8 | 9 | ```markdown 10 | This is an H1 11 | ============= 12 | 13 | This is an H2 14 | ------------- 15 | ``` 16 | 17 | Any number of underlining =’s or -’s will work. 18 | 19 | Atx-style headers use 1-6 hash characters at the start of the line, corresponding to header levels 1-6. For example: 20 | 21 | ```markdown 22 | # This is an H1 23 | 24 | ## This is an H2 25 | 26 | ###### This is an H6 27 | ``` 28 | 29 | 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.) : 30 | 31 | ```markdown 32 | # This is an H1 # 33 | 34 | ## This is an H2 ## 35 | 36 | ### This is an H3 ###### 37 | ``` 38 | --------------------------------------------------------------------------------