This is a Markdown Usage example.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

244 lines
4.5 KiB

2 years ago
  1. ---
  2. __Advertisement :)__
  3. - __[pica](https://nodeca.github.io/pica/demo/)__ - high quality and fast image
  4. resize in browser.
  5. - __[babelfish](https://github.com/nodeca/babelfish/)__ - developer friendly
  6. i18n with plurals support and easy syntax.
  7. You will like those projects!
  8. ---
  9. # h1 Heading 8-)
  10. ## h2 Heading
  11. ### h3 Heading
  12. #### h4 Heading
  13. ##### h5 Heading
  14. ###### h6 Heading
  15. ## Horizontal Rules
  16. ___
  17. ---
  18. ***
  19. ## Typographic replacements
  20. Enable typographer option to see result.
  21. (c) (C) (r) (R) (tm) (TM) (p) (P) +-
  22. test.. test... test..... test?..... test!....
  23. !!!!!! ???? ,, -- ---
  24. "Smartypants, double quotes" and 'single quotes'
  25. ## Emphasis
  26. **This is bold text**
  27. __This is bold text__
  28. *This is italic text*
  29. _This is italic text_
  30. ~~Strikethrough~~
  31. ## Blockquotes
  32. > Blockquotes can also be nested...
  33. >> ...by using additional greater-than signs right next to each other...
  34. > > > ...or with spaces between arrows.
  35. ## Lists
  36. Unordered
  37. + Create a list by starting a line with `+`, `-`, or `*`
  38. + Sub-lists are made by indenting 2 spaces:
  39. - Marker character change forces new list start:
  40. * Ac tristique libero volutpat at
  41. + Facilisis in pretium nisl aliquet
  42. - Nulla volutpat aliquam velit
  43. + Very easy!
  44. Ordered
  45. 1. Lorem ipsum dolor sit amet
  46. 2. Consectetur adipiscing elit
  47. 3. Integer molestie lorem at massa
  48. 1. You can use sequential numbers...
  49. 1. ...or keep all the numbers as `1.`
  50. Start numbering with offset:
  51. 57. foo
  52. 1. bar
  53. ## Code
  54. Inline `code`
  55. Indented code
  56. // Some comments
  57. line 1 of code
  58. line 2 of code
  59. line 3 of code
  60. Block code "fences"
  61. ```
  62. Sample text here...
  63. ```
  64. Syntax highlighting
  65. ``` js
  66. var foo = function (bar) {
  67. return bar++;
  68. };
  69. console.log(foo(5));
  70. ```
  71. ## Tables
  72. | Option | Description |
  73. | ------ | ----------- |
  74. | data | path to data files to supply the data that will be passed into templates. |
  75. | engine | engine to be used for processing templates. Handlebars is the default. |
  76. | ext | extension to be used for dest files. |
  77. Right aligned columns
  78. | Option | Description |
  79. | ------:| -----------:|
  80. | data | path to data files to supply the data that will be passed into templates. |
  81. | engine | engine to be used for processing templates. Handlebars is the default. |
  82. | ext | extension to be used for dest files. |
  83. ## Links
  84. [link text](http://dev.nodeca.com)
  85. [link with title](http://nodeca.github.io/pica/demo/ "title text!")
  86. Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
  87. ## Images
  88. ![Minion](https://octodex.github.com/images/minion.png)
  89. ![Stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
  90. Like links, Images also have a footnote style syntax
  91. ![Alt text][id]
  92. With a reference later in the document defining the URL location:
  93. [id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
  94. ## Plugins
  95. The killer feature of `markdown-it` is very effective support of
  96. [syntax plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin).
  97. ### [Emojies](https://github.com/markdown-it/markdown-it-emoji)
  98. > Classic markup: :wink: :cry: :laughing: :yum:
  99. >
  100. > Shortcuts (emoticons): :-) :-( 8-) ;)
  101. see [how to change output](https://github.com/markdown-it/markdown-it-emoji#change-output) with twemoji.
  102. ### [Subscript](https://github.com/markdown-it/markdown-it-sub) / [Superscript](https://github.com/markdown-it/markdown-it-sup)
  103. - 19^th^
  104. - H~2~O
  105. ### [\<ins>](https://github.com/markdown-it/markdown-it-ins)
  106. ++Inserted text++
  107. ### [\<mark>](https://github.com/markdown-it/markdown-it-mark)
  108. ==Marked text==
  109. ### [Footnotes](https://github.com/markdown-it/markdown-it-footnote)
  110. Footnote 1 link[^first].
  111. Footnote 2 link[^second].
  112. Inline footnote^[Text of inline footnote] definition.
  113. Duplicated footnote reference[^second].
  114. [^first]: Footnote **can have markup**
  115. and multiple paragraphs.
  116. [^second]: Footnote text.
  117. ### [Definition lists](https://github.com/markdown-it/markdown-it-deflist)
  118. Term 1
  119. : Definition 1
  120. with lazy continuation.
  121. Term 2 with *inline markup*
  122. : Definition 2
  123. { some code, part of Definition 2 }
  124. Third paragraph of definition 2.
  125. _Compact style:_
  126. Term 1
  127. ~ Definition 1
  128. Term 2
  129. ~ Definition 2a
  130. ~ Definition 2b
  131. ### [Abbreviations](https://github.com/markdown-it/markdown-it-abbr)
  132. This is HTML abbreviation example.
  133. It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
  134. *[HTML]: Hyper Text Markup Language
  135. ### [Custom containers](https://github.com/markdown-it/markdown-it-container)
  136. ::: warning
  137. *here be dragons*
  138. :::