rbcli 0.2.11 → 0.2.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (426) hide show
  1. checksums.yaml +4 -4
  2. data/.rakeTasks +7 -0
  3. data/.rbenv-gemsets +1 -0
  4. data/CHANGELOG.md +22 -0
  5. data/Gemfile.lock +25 -24
  6. data/README.md +2 -2
  7. data/docs-src/archetypes/default.md +6 -0
  8. data/docs-src/config.toml +37 -0
  9. data/docs-src/{docs/index.md → content/_index.md} +4 -4
  10. data/docs-src/content/advanced/_index.md +11 -0
  11. data/docs-src/{docs → content}/advanced/automatic_updates.md +6 -2
  12. data/docs-src/{docs → content}/advanced/command_types.md +8 -4
  13. data/docs-src/{docs → content}/advanced/distributed_state_locking.md +6 -2
  14. data/docs-src/{docs → content}/advanced/hooks.md +6 -2
  15. data/docs-src/{docs → content}/advanced/interactive_commands.md +5 -1
  16. data/docs-src/{docs → content}/advanced/logging.md +6 -2
  17. data/docs-src/{docs → content}/advanced/remote_execution.md +5 -1
  18. data/docs-src/{docs → content}/advanced/state_storage.md +6 -3
  19. data/docs-src/{docs → content}/advanced/user_config_files.md +5 -1
  20. data/docs-src/content/development/_index.md +11 -0
  21. data/docs-src/{docs/imported → content/development}/changelog.md +58 -6
  22. data/docs-src/{docs → content}/development/code_of_conduct.md +8 -1
  23. data/docs-src/{docs → content}/development/contributing.md +16 -1
  24. data/docs-src/{docs → content}/development/license.md +9 -2
  25. data/docs-src/{docs/imported/quick_reference.md → content/quick_reference/_index.md} +8 -1
  26. data/docs-src/{docs → content}/tutorial/10-getting_started.md +7 -1
  27. data/docs-src/{docs → content}/tutorial/20-project_layout.md +10 -2
  28. data/docs-src/{docs → content}/tutorial/30-your_first_command.md +10 -4
  29. data/docs-src/{docs → content}/tutorial/40-options_parameters_and_arguments.md +9 -3
  30. data/docs-src/{docs → content}/tutorial/50-publishing.md +9 -3
  31. data/docs-src/content/tutorial/_index.md +11 -0
  32. data/docs-src/{docs/whoami.md → content/whoami/_index.md} +11 -5
  33. data/docs-src/layouts/partials/logo.html +3 -0
  34. data/docs-src/makesite.sh +33 -7
  35. data/docs-src/mkdocs-archived.tar.gz +0 -0
  36. data/docs-src/runsite.sh +6 -1
  37. data/docs-src/themes/hugo-theme-learn/.editorconfig +16 -0
  38. data/docs-src/themes/hugo-theme-learn/.gitignore +3 -0
  39. data/docs-src/themes/hugo-theme-learn/.grenrc.yml +25 -0
  40. data/docs-src/themes/hugo-theme-learn/CHANGELOG.md +154 -0
  41. data/docs-src/themes/hugo-theme-learn/LICENSE.md +22 -0
  42. data/docs-src/themes/hugo-theme-learn/README.md +60 -0
  43. data/docs-src/themes/hugo-theme-learn/archetypes/chapter.md +13 -0
  44. data/docs-src/themes/hugo-theme-learn/archetypes/default.md +7 -0
  45. data/docs-src/themes/hugo-theme-learn/exampleSite/LICENSE.md +20 -0
  46. data/docs-src/themes/hugo-theme-learn/exampleSite/config.toml +75 -0
  47. data/docs-src/themes/hugo-theme-learn/exampleSite/content/_index.en.md +41 -0
  48. data/docs-src/themes/hugo-theme-learn/exampleSite/content/_index.fr.md +43 -0
  49. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.en.md +12 -0
  50. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.fr.md +12 -0
  51. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.en.md +58 -0
  52. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.fr.md +54 -0
  53. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.en.md +102 -0
  54. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.fr.md +100 -0
  55. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/images/chapter.png +0 -0
  56. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.en.md +11 -0
  57. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.fr.md +11 -0
  58. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/images/magic.gif +0 -0
  59. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.en.md +194 -0
  60. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.fr.md +194 -0
  61. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/blue-variant.png +0 -0
  62. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/green-variant.png +0 -0
  63. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/red-variant.png +0 -0
  64. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/_index.en.md +12 -0
  65. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/_index.fr.md +12 -0
  66. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.en.md +57 -0
  67. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.fr.md +57 -0
  68. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/_index.en.md +78 -0
  69. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/_index.fr.md +78 -0
  70. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/images/i18n-menu.gif +0 -0
  71. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/icons.en.md +41 -0
  72. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.en.md +665 -0
  73. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.fr.md +666 -0
  74. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/menushortcuts.en.md +109 -0
  75. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/menushortcuts.fr.md +109 -0
  76. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.en.md +166 -0
  77. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.fr.md +146 -0
  78. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/frontmatter-icon.png +0 -0
  79. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/pages-chapter.png +0 -0
  80. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/pages-default.png +0 -0
  81. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/tags.en.md +39 -0
  82. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/tags.fr.md +40 -0
  83. data/docs-src/themes/hugo-theme-learn/exampleSite/content/credits.en.md +28 -0
  84. data/docs-src/themes/hugo-theme-learn/exampleSite/content/credits.fr.md +28 -0
  85. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/_index.en.md +16 -0
  86. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/_index.fr.md +16 -0
  87. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/BachGavotteShort.mp3 +0 -0
  88. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf +0 -0
  89. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf +0 -0
  90. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/hugo.png +0 -0
  91. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4 +0 -0
  92. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.md +85 -0
  93. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/BachGavotteShort.mp3 +0 -0
  94. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/Carroll_AliceAuPaysDesMerveilles.pdf +0 -0
  95. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/adivorciarsetoca00cape.pdf +0 -0
  96. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/hugo.png +0 -0
  97. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/movieselectricsheep-flock-244-32500-2.mp4 +0 -0
  98. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.md +85 -0
  99. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.en.md +16 -0
  100. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.fr.md +16 -0
  101. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.en.md +45 -0
  102. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.fr.md +45 -0
  103. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/_index.en.md +6 -0
  104. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/_index.fr.md +6 -0
  105. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en.md +6 -0
  106. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.fr.md +6 -0
  107. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.en.md +6 -0
  108. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.fr.md +6 -0
  109. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.en.md +6 -0
  110. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.fr.md +6 -0
  111. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.en.md +6 -0
  112. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.fr.md +6 -0
  113. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/_index.en.md +11 -0
  114. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/_index.fr.md +11 -0
  115. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/test3.en.md +6 -0
  116. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/test3.fr.md +6 -0
  117. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-3/_index.en.md +6 -0
  118. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-3/_index.fr.md +6 -0
  119. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-4/_index.en.md +7 -0
  120. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-4/_index.fr.md +7 -0
  121. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/test.en.md +6 -0
  122. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/test.fr.md +6 -0
  123. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/expand.en.md +45 -0
  124. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/expand.fr.md +45 -0
  125. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/mermaid.en.md +283 -0
  126. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/mermaid.fr.md +283 -0
  127. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.en.md +62 -0
  128. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.fr.md +62 -0
  129. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/siteparam.en.md +23 -0
  130. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/siteparam.fr.md +23 -0
  131. data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.en.md +10 -0
  132. data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.fr.md +11 -0
  133. data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/custom-footer.html +10 -0
  134. data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/logo.html +39 -0
  135. data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/menu-footer.html +14 -0
  136. data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/shortcodes/ghcontributors.html +31 -0
  137. data/docs-src/themes/hugo-theme-learn/exampleSite/static/css/theme-mine.css +104 -0
  138. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.eot +0 -0
  139. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.svg +237 -0
  140. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.ttf +0 -0
  141. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.woff +0 -0
  142. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.woff2 +0 -0
  143. data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/tat.png +0 -0
  144. data/docs-src/themes/hugo-theme-learn/i18n/en.toml +26 -0
  145. data/docs-src/themes/hugo-theme-learn/i18n/es.toml +26 -0
  146. data/docs-src/themes/hugo-theme-learn/i18n/fr.toml +26 -0
  147. data/docs-src/themes/hugo-theme-learn/i18n/id.toml +26 -0
  148. data/docs-src/themes/hugo-theme-learn/i18n/nl.toml +26 -0
  149. data/docs-src/themes/hugo-theme-learn/i18n/pt.toml +26 -0
  150. data/docs-src/themes/hugo-theme-learn/i18n/tr.toml +26 -0
  151. data/docs-src/themes/hugo-theme-learn/images/screenshot.png +0 -0
  152. data/docs-src/themes/hugo-theme-learn/images/tn.png +0 -0
  153. data/docs-src/themes/hugo-theme-learn/layouts/404.html +56 -0
  154. data/docs-src/themes/hugo-theme-learn/layouts/_default/list.html +22 -0
  155. data/docs-src/themes/hugo-theme-learn/layouts/_default/single.html +13 -0
  156. data/docs-src/themes/hugo-theme-learn/layouts/index.html +31 -0
  157. data/docs-src/themes/hugo-theme-learn/layouts/index.json +12 -0
  158. data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-comments.html +3 -0
  159. data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-footer.html +5 -0
  160. data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-header.html +5 -0
  161. data/docs-src/themes/hugo-theme-learn/layouts/partials/favicon.html +1 -0
  162. data/docs-src/themes/hugo-theme-learn/layouts/partials/footer.html +78 -0
  163. data/docs-src/themes/hugo-theme-learn/layouts/partials/header.html +109 -0
  164. data/docs-src/themes/hugo-theme-learn/layouts/partials/logo.html +19 -0
  165. data/docs-src/themes/hugo-theme-learn/layouts/partials/menu-footer.html +1 -0
  166. data/docs-src/themes/hugo-theme-learn/layouts/partials/menu.html +150 -0
  167. data/docs-src/themes/hugo-theme-learn/layouts/partials/meta.html +2 -0
  168. data/docs-src/themes/hugo-theme-learn/layouts/partials/search.html +16 -0
  169. data/docs-src/themes/hugo-theme-learn/layouts/partials/tags.html +7 -0
  170. data/docs-src/themes/hugo-theme-learn/layouts/partials/toc.html +5 -0
  171. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/attachments.html +36 -0
  172. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/button.html +14 -0
  173. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/children.html +101 -0
  174. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/expand.html +17 -0
  175. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/mermaid.html +2 -0
  176. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/notice.html +2 -0
  177. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/ref.html +14 -0
  178. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/relref.html +14 -0
  179. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/siteparam.html +7 -0
  180. data/docs-src/themes/hugo-theme-learn/netlify.toml +24 -0
  181. data/docs-src/themes/hugo-theme-learn/static/css/atom-one-dark-reasonable.css +77 -0
  182. data/docs-src/themes/hugo-theme-learn/static/css/auto-complete.css +47 -0
  183. data/docs-src/themes/hugo-theme-learn/static/css/featherlight.min.css +8 -0
  184. data/docs-src/themes/hugo-theme-learn/static/css/fontawesome-all.min.css +1 -0
  185. data/docs-src/themes/hugo-theme-learn/static/css/hugo-theme.css +254 -0
  186. data/docs-src/themes/hugo-theme-learn/static/css/hybrid.css +102 -0
  187. data/docs-src/themes/hugo-theme-learn/static/css/nucleus.css +615 -0
  188. data/docs-src/themes/hugo-theme-learn/static/css/perfect-scrollbar.min.css +2 -0
  189. data/docs-src/themes/hugo-theme-learn/static/css/tags.css +49 -0
  190. data/docs-src/themes/hugo-theme-learn/static/css/theme-blue.css +111 -0
  191. data/docs-src/themes/hugo-theme-learn/static/css/theme-green.css +111 -0
  192. data/docs-src/themes/hugo-theme-learn/static/css/theme-red.css +111 -0
  193. data/docs-src/themes/hugo-theme-learn/static/css/theme.css +1132 -0
  194. data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.eot +0 -0
  195. data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.svg +359 -0
  196. data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.ttf +0 -0
  197. data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.woff +0 -0
  198. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.eot +0 -0
  199. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.svg +1019 -0
  200. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.ttf +0 -0
  201. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.woff +0 -0
  202. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.woff2 +0 -0
  203. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.eot +0 -0
  204. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg +918 -0
  205. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.ttf +0 -0
  206. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff +0 -0
  207. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff2 +0 -0
  208. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.eot +0 -0
  209. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.svg +332 -0
  210. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.ttf +0 -0
  211. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.woff +0 -0
  212. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.woff2 +0 -0
  213. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.eot +0 -0
  214. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.svg +331 -0
  215. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.ttf +0 -0
  216. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.woff +0 -0
  217. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.woff2 +0 -0
  218. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.eot +0 -0
  219. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.svg +333 -0
  220. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.ttf +0 -0
  221. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.woff +0 -0
  222. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.woff2 +0 -0
  223. data/docs-src/themes/hugo-theme-learn/static/images/clippy.svg +1 -0
  224. data/docs-src/themes/hugo-theme-learn/static/images/favicon.png +0 -0
  225. data/docs-src/themes/hugo-theme-learn/static/images/gopher-404.jpg +0 -0
  226. data/docs-src/themes/hugo-theme-learn/static/js/auto-complete.js +223 -0
  227. data/docs-src/themes/hugo-theme-learn/static/js/clipboard.min.js +7 -0
  228. data/docs-src/themes/hugo-theme-learn/static/js/featherlight.min.js +9 -0
  229. data/docs-src/themes/hugo-theme-learn/static/js/highlight.pack.js +3 -0
  230. data/docs-src/themes/hugo-theme-learn/static/js/html5shiv-printshiv.min.js +4 -0
  231. data/docs-src/themes/hugo-theme-learn/static/js/hugo-learn.js +91 -0
  232. data/docs-src/themes/hugo-theme-learn/static/js/jquery-3.3.1.min.js +2 -0
  233. data/docs-src/themes/hugo-theme-learn/static/js/jquery.sticky.js +288 -0
  234. data/docs-src/themes/hugo-theme-learn/static/js/learn.js +459 -0
  235. data/docs-src/themes/hugo-theme-learn/static/js/lunr.min.js +6 -0
  236. data/docs-src/themes/hugo-theme-learn/static/js/modernizr.custom-3.6.0.js +3 -0
  237. data/docs-src/themes/hugo-theme-learn/static/js/perfect-scrollbar.jquery.min.js +2 -0
  238. data/docs-src/themes/hugo-theme-learn/static/js/perfect-scrollbar.min.js +2 -0
  239. data/docs-src/themes/hugo-theme-learn/static/js/search.js +93 -0
  240. data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.css +277 -0
  241. data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.dark.css +278 -0
  242. data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.forest.css +356 -0
  243. data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.js +8 -0
  244. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.eot +0 -0
  245. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.svg +1260 -0
  246. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.ttf +0 -0
  247. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.woff +0 -0
  248. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.woff2 +0 -0
  249. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.eot +0 -0
  250. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.svg +471 -0
  251. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.ttf +0 -0
  252. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.woff +0 -0
  253. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.woff2 +0 -0
  254. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.eot +0 -0
  255. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.svg +2763 -0
  256. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.ttf +0 -0
  257. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.woff +0 -0
  258. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.woff2 +0 -0
  259. data/docs-src/themes/hugo-theme-learn/theme.toml +21 -0
  260. data/docs-src/themes/hugo-theme-learn/wercker.yml +16 -0
  261. data/docs/404.html +54 -670
  262. data/docs/advanced/automatic_updates/index.html +962 -635
  263. data/docs/advanced/command_types/index.html +1021 -736
  264. data/docs/advanced/distributed_state_locking/index.html +957 -622
  265. data/docs/advanced/hooks/index.html +968 -661
  266. data/docs/advanced/index.html +1099 -0
  267. data/docs/advanced/index.xml +117 -0
  268. data/docs/advanced/interactive_commands/index.html +960 -636
  269. data/docs/advanced/logging/index.html +963 -639
  270. data/docs/advanced/remote_execution/index.html +959 -634
  271. data/docs/advanced/state_storage/index.html +1049 -764
  272. data/docs/advanced/user_config_files/index.html +981 -649
  273. data/docs/categories/index.html +1094 -0
  274. data/docs/categories/index.xml +14 -0
  275. data/docs/css/atom-one-dark-reasonable.css +77 -0
  276. data/docs/css/auto-complete.css +47 -0
  277. data/docs/css/featherlight.min.css +8 -0
  278. data/docs/css/fontawesome-all.min.css +1 -0
  279. data/docs/css/hugo-theme.css +254 -0
  280. data/docs/css/hybrid.css +102 -0
  281. data/docs/css/nucleus.css +615 -0
  282. data/docs/css/perfect-scrollbar.min.css +2 -0
  283. data/docs/css/tags.css +49 -0
  284. data/docs/css/theme-blue.css +111 -0
  285. data/docs/css/theme-green.css +111 -0
  286. data/docs/css/theme-red.css +111 -0
  287. data/docs/css/theme.css +1132 -0
  288. data/docs/development/changelog/index.html +1368 -0
  289. data/docs/development/code_of_conduct/index.html +969 -687
  290. data/docs/development/contributing/index.html +993 -587
  291. data/docs/development/index.html +1099 -0
  292. data/docs/development/index.xml +54 -0
  293. data/docs/development/license/index.html +959 -579
  294. data/docs/fonts/Inconsolata.eot +0 -0
  295. data/docs/fonts/Inconsolata.svg +359 -0
  296. data/docs/fonts/Inconsolata.ttf +0 -0
  297. data/docs/fonts/Inconsolata.woff +0 -0
  298. data/docs/fonts/Novecentosanswide-Normal-webfont.eot +0 -0
  299. data/docs/fonts/Novecentosanswide-Normal-webfont.svg +1019 -0
  300. data/docs/fonts/Novecentosanswide-Normal-webfont.ttf +0 -0
  301. data/docs/fonts/Novecentosanswide-Normal-webfont.woff +0 -0
  302. data/docs/fonts/Novecentosanswide-Normal-webfont.woff2 +0 -0
  303. data/docs/fonts/Novecentosanswide-UltraLight-webfont.eot +0 -0
  304. data/docs/fonts/Novecentosanswide-UltraLight-webfont.svg +918 -0
  305. data/docs/fonts/Novecentosanswide-UltraLight-webfont.ttf +0 -0
  306. data/docs/fonts/Novecentosanswide-UltraLight-webfont.woff +0 -0
  307. data/docs/fonts/Novecentosanswide-UltraLight-webfont.woff2 +0 -0
  308. data/docs/fonts/Work_Sans_200.eot +0 -0
  309. data/docs/fonts/Work_Sans_200.svg +332 -0
  310. data/docs/fonts/Work_Sans_200.ttf +0 -0
  311. data/docs/fonts/Work_Sans_200.woff +0 -0
  312. data/docs/fonts/Work_Sans_200.woff2 +0 -0
  313. data/docs/fonts/Work_Sans_300.eot +0 -0
  314. data/docs/fonts/Work_Sans_300.svg +331 -0
  315. data/docs/fonts/Work_Sans_300.ttf +0 -0
  316. data/docs/fonts/Work_Sans_300.woff +0 -0
  317. data/docs/fonts/Work_Sans_300.woff2 +0 -0
  318. data/docs/fonts/Work_Sans_500.eot +0 -0
  319. data/docs/fonts/Work_Sans_500.svg +333 -0
  320. data/docs/fonts/Work_Sans_500.ttf +0 -0
  321. data/docs/fonts/Work_Sans_500.woff +0 -0
  322. data/docs/fonts/Work_Sans_500.woff2 +0 -0
  323. data/docs/images/clippy.svg +1 -0
  324. data/docs/images/favicon.png +0 -0
  325. data/docs/images/gopher-404.jpg +0 -0
  326. data/docs/imported/changelog/index.html +1208 -1020
  327. data/docs/imported/index.html +1191 -0
  328. data/docs/imported/index.xml +23 -0
  329. data/docs/index.html +907 -591
  330. data/docs/index.json +183 -0
  331. data/docs/index.xml +212 -0
  332. data/docs/js/auto-complete.js +223 -0
  333. data/docs/js/clipboard.min.js +7 -0
  334. data/docs/js/featherlight.min.js +9 -0
  335. data/docs/js/highlight.pack.js +3 -0
  336. data/docs/js/html5shiv-printshiv.min.js +4 -0
  337. data/docs/js/hugo-learn.js +91 -0
  338. data/docs/js/jquery-3.3.1.min.js +2 -0
  339. data/docs/js/jquery.sticky.js +288 -0
  340. data/docs/js/learn.js +459 -0
  341. data/docs/js/lunr.min.js +6 -0
  342. data/docs/js/modernizr.custom-3.6.0.js +3 -0
  343. data/docs/js/perfect-scrollbar.jquery.min.js +2 -0
  344. data/docs/js/perfect-scrollbar.min.js +2 -0
  345. data/docs/js/search.js +93 -0
  346. data/docs/mermaid/mermaid.css +277 -0
  347. data/docs/mermaid/mermaid.dark.css +278 -0
  348. data/docs/mermaid/mermaid.forest.css +356 -0
  349. data/docs/mermaid/mermaid.js +8 -0
  350. data/docs/quick_reference/index.html +1279 -0
  351. data/docs/quick_reference/index.xml +15 -0
  352. data/docs/sitemap.xml +135 -107
  353. data/docs/tags/index.html +1094 -0
  354. data/docs/tags/index.xml +14 -0
  355. data/docs/tutorial/10-getting_started/index.html +960 -649
  356. data/docs/tutorial/20-project_layout/index.html +1059 -778
  357. data/docs/tutorial/30-your_first_command/index.html +1040 -729
  358. data/docs/tutorial/40-options_parameters_and_arguments/index.html +1151 -868
  359. data/docs/tutorial/50-publishing/index.html +969 -676
  360. data/docs/tutorial/index.html +1099 -0
  361. data/docs/tutorial/index.xml +71 -0
  362. data/docs/webfonts/fa-brands-400.eot +0 -0
  363. data/docs/webfonts/fa-brands-400.svg +1260 -0
  364. data/docs/webfonts/fa-brands-400.ttf +0 -0
  365. data/docs/webfonts/fa-brands-400.woff +0 -0
  366. data/docs/webfonts/fa-brands-400.woff2 +0 -0
  367. data/docs/webfonts/fa-regular-400.eot +0 -0
  368. data/docs/webfonts/fa-regular-400.svg +471 -0
  369. data/docs/webfonts/fa-regular-400.ttf +0 -0
  370. data/docs/webfonts/fa-regular-400.woff +0 -0
  371. data/docs/webfonts/fa-regular-400.woff2 +0 -0
  372. data/docs/webfonts/fa-solid-900.eot +0 -0
  373. data/docs/webfonts/fa-solid-900.svg +2763 -0
  374. data/docs/webfonts/fa-solid-900.ttf +0 -0
  375. data/docs/webfonts/fa-solid-900.woff +0 -0
  376. data/docs/webfonts/fa-solid-900.woff2 +0 -0
  377. data/docs/whoami/index.html +947 -567
  378. data/docs/whoami/index.xml +15 -0
  379. data/exe/rbcli +1 -0
  380. data/lib/rbcli-tool/project.rb +6 -2
  381. data/lib/rbcli/version.rb +1 -1
  382. data/rbcli.gemspec +1 -1
  383. data/skeletons/project/.rakeTasks +7 -0
  384. data/skeletons/project/exe/executable +1 -3
  385. data/skeletons/project/lib/lib.erb +7 -0
  386. data/skeletons/project/untitled.gemspec +13 -15
  387. metadata +356 -65
  388. data/docs-src/mkdocs.yml +0 -79
  389. data/docs/assets/fonts/font-awesome.css +0 -4
  390. data/docs/assets/fonts/material-icons.css +0 -13
  391. data/docs/assets/fonts/specimen/FontAwesome.ttf +0 -0
  392. data/docs/assets/fonts/specimen/FontAwesome.woff +0 -0
  393. data/docs/assets/fonts/specimen/FontAwesome.woff2 +0 -0
  394. data/docs/assets/fonts/specimen/MaterialIcons-Regular.ttf +0 -0
  395. data/docs/assets/fonts/specimen/MaterialIcons-Regular.woff +0 -0
  396. data/docs/assets/fonts/specimen/MaterialIcons-Regular.woff2 +0 -0
  397. data/docs/assets/images/favicon.png +0 -0
  398. data/docs/assets/images/icons/bitbucket.1b09e088.svg +0 -20
  399. data/docs/assets/images/icons/github.f0b8504a.svg +0 -18
  400. data/docs/assets/images/icons/gitlab.6dd19c00.svg +0 -38
  401. data/docs/assets/javascripts/application.583bbe55.js +0 -1
  402. data/docs/assets/javascripts/lunr/lunr.da.js +0 -1
  403. data/docs/assets/javascripts/lunr/lunr.de.js +0 -1
  404. data/docs/assets/javascripts/lunr/lunr.du.js +0 -1
  405. data/docs/assets/javascripts/lunr/lunr.es.js +0 -1
  406. data/docs/assets/javascripts/lunr/lunr.fi.js +0 -1
  407. data/docs/assets/javascripts/lunr/lunr.fr.js +0 -1
  408. data/docs/assets/javascripts/lunr/lunr.hu.js +0 -1
  409. data/docs/assets/javascripts/lunr/lunr.it.js +0 -1
  410. data/docs/assets/javascripts/lunr/lunr.jp.js +0 -1
  411. data/docs/assets/javascripts/lunr/lunr.multi.js +0 -1
  412. data/docs/assets/javascripts/lunr/lunr.no.js +0 -1
  413. data/docs/assets/javascripts/lunr/lunr.pt.js +0 -1
  414. data/docs/assets/javascripts/lunr/lunr.ro.js +0 -1
  415. data/docs/assets/javascripts/lunr/lunr.ru.js +0 -1
  416. data/docs/assets/javascripts/lunr/lunr.stemmer.support.js +0 -1
  417. data/docs/assets/javascripts/lunr/lunr.sv.js +0 -1
  418. data/docs/assets/javascripts/lunr/lunr.tr.js +0 -1
  419. data/docs/assets/javascripts/lunr/tinyseg.js +0 -1
  420. data/docs/assets/javascripts/modernizr.1aa3b519.js +0 -1
  421. data/docs/assets/stylesheets/application-palette.22915126.css +0 -1176
  422. data/docs/assets/stylesheets/application.451f80e5.css +0 -2552
  423. data/docs/imported/quick_reference/index.html +0 -1120
  424. data/docs/search/search_index.json +0 -1
  425. data/docs/sitemap.xml.gz +0 -0
  426. data/skeletons/project/lib/.keep +0 -0
@@ -0,0 +1,666 @@
1
+ ---
2
+ date: 2016-04-09T16:50:16+02:00
3
+ title: Syntaxe Markdown
4
+ weight: 15
5
+ ---
6
+
7
+ {{% notice note %}}
8
+ Cette page est une copie de la [doc de Grav](http://learn.getgrav.org/content/markdown).
9
+ La seule différence porte sur la personalisation des images ([taille]({{< relref "#resizing-image" >}}), [ajout de classes CSS]({{< relref "#add-css-classes" >}})...)
10
+ Pour des raisons évidentes, cette page n'a pas été traduites en français 😁
11
+ {{% /notice%}}
12
+
13
+ Let's face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.
14
+
15
+ **Markdown** is a better way to write **HTML**, without all the complexities and ugliness that usually accompanies it.
16
+
17
+ Some of the key benefits are:
18
+
19
+ 1. Markdown is simple to learn, with minimal extra characters so it's also quicker to write content.
20
+ 2. Less chance of errors when writing in markdown.
21
+ 3. Produces valid XHTML output.
22
+ 4. Keeps the content and the visual display separate, so you cannot mess up the look of your site.
23
+ 5. Write in any text editor or Markdown application you like.
24
+ 6. Markdown is a joy to use!
25
+
26
+ John Gruber, the author of Markdown, puts it like this:
27
+
28
+ > The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
29
+ > -- <cite>John Gruber</cite>
30
+
31
+
32
+ Grav ships with built-in support for [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). You must enable **Markdown Extra** in your `system.yaml` configuration file
33
+
34
+ Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:
35
+
36
+ {{% notice info %}}
37
+ <i class="fas fa-bookmark"></i> Bookmark this page for easy future reference!
38
+ {{% /notice %}}
39
+
40
+ ## Headings
41
+
42
+ Headings from `h1` through `h6` are constructed with a `#` for each level:
43
+
44
+ ```markdown
45
+ # h1 Heading
46
+ ## h2 Heading
47
+ ### h3 Heading
48
+ #### h4 Heading
49
+ ##### h5 Heading
50
+ ###### h6 Heading
51
+ ```
52
+
53
+ Renders to:
54
+
55
+ # h1 Heading
56
+ ## h2 Heading
57
+ ### h3 Heading
58
+ #### h4 Heading
59
+ ##### h5 Heading
60
+ ###### h6 Heading
61
+
62
+ HTML:
63
+
64
+ ```html
65
+ <h1>h1 Heading</h1>
66
+ <h2>h2 Heading</h2>
67
+ <h3>h3 Heading</h3>
68
+ <h4>h4 Heading</h4>
69
+ <h5>h5 Heading</h5>
70
+ <h6>h6 Heading</h6>
71
+ ```
72
+
73
+ ## Comments
74
+
75
+ Comments should be HTML compatible
76
+
77
+ ```html
78
+ <!--
79
+ This is a comment
80
+ -->
81
+ ```
82
+ Comment below should **NOT** be seen:
83
+
84
+ <!--
85
+ This is a comment
86
+ -->
87
+
88
+
89
+ ## Horizontal Rules
90
+
91
+ The HTML `<hr>` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `<hr>` with any of the following:
92
+
93
+ * `___`: three consecutive underscores
94
+ * `---`: three consecutive dashes
95
+ * `***`: three consecutive asterisks
96
+
97
+ renders to:
98
+
99
+ ___
100
+
101
+ ---
102
+
103
+ ***
104
+
105
+
106
+ ## Body Copy
107
+
108
+ Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML.
109
+
110
+ So this body copy:
111
+
112
+ ```markdown
113
+ Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
114
+ ```
115
+ renders to this HTML:
116
+
117
+ ```html
118
+ <p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
119
+ ```
120
+
121
+ ## Emphasis
122
+
123
+ ### Bold
124
+ For emphasizing a snippet of text with a heavier font-weight.
125
+
126
+ The following snippet of text is **rendered as bold text**.
127
+
128
+ ```markdown
129
+ **rendered as bold text**
130
+ ```
131
+ renders to:
132
+
133
+ **rendered as bold text**
134
+
135
+ and this HTML
136
+
137
+ ```html
138
+ <strong>rendered as bold text</strong>
139
+ ```
140
+
141
+ ### Italics
142
+ For emphasizing a snippet of text with italics.
143
+
144
+ The following snippet of text is _rendered as italicized text_.
145
+
146
+ ```markdown
147
+ _rendered as italicized text_
148
+ ```
149
+
150
+ renders to:
151
+
152
+ _rendered as italicized text_
153
+
154
+ and this HTML:
155
+
156
+ ```html
157
+ <em>rendered as italicized text</em>
158
+ ```
159
+
160
+
161
+ ### strikethrough
162
+ In GFM (GitHub flavored Markdown) you can do strikethroughs.
163
+
164
+ ```markdown
165
+ ~~Strike through this text.~~
166
+ ```
167
+ Which renders to:
168
+
169
+ ~~Strike through this text.~~
170
+
171
+ HTML:
172
+
173
+ ```html
174
+ <del>Strike through this text.</del>
175
+ ```
176
+
177
+ ## Blockquotes
178
+
179
+ For quoting blocks of content from another source within your document.
180
+
181
+ Add `>` before any text you want to quote.
182
+
183
+ ```markdown
184
+ > **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
185
+ ```
186
+
187
+ Renders to:
188
+
189
+ > **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
190
+
191
+ and this HTML:
192
+
193
+ ```html
194
+ <blockquote>
195
+ <p><strong>Fusion Drive</strong> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.</p>
196
+ </blockquote>
197
+ ```
198
+
199
+ Blockquotes can also be nested:
200
+
201
+ ```markdown
202
+ > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
203
+ >
204
+ > > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
205
+ >
206
+ > Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
207
+ ```
208
+
209
+ Renders to:
210
+
211
+ > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
212
+ >
213
+ > > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
214
+ >
215
+ > Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
216
+
217
+ ## Notices
218
+
219
+ {{% notice note %}}
220
+ The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices)
221
+ {{% /notice %}}
222
+
223
+ ## Lists
224
+
225
+ ### Unordered
226
+ A list of items in which the order of the items does not explicitly matter.
227
+
228
+ You may use any of the following symbols to denote bullets for each list item:
229
+
230
+ ```markdown
231
+ * valid bullet
232
+ - valid bullet
233
+ + valid bullet
234
+ ```
235
+
236
+ For example
237
+
238
+ ```markdown
239
+ + Lorem ipsum dolor sit amet
240
+ + Consectetur adipiscing elit
241
+ + Integer molestie lorem at massa
242
+ + Facilisis in pretium nisl aliquet
243
+ + Nulla volutpat aliquam velit
244
+ - Phasellus iaculis neque
245
+ - Purus sodales ultricies
246
+ - Vestibulum laoreet porttitor sem
247
+ - Ac tristique libero volutpat at
248
+ + Faucibus porta lacus fringilla vel
249
+ + Aenean sit amet erat nunc
250
+ + Eget porttitor lorem
251
+ ```
252
+ Renders to:
253
+
254
+ + Lorem ipsum dolor sit amet
255
+ + Consectetur adipiscing elit
256
+ + Integer molestie lorem at massa
257
+ + Facilisis in pretium nisl aliquet
258
+ + Nulla volutpat aliquam velit
259
+ - Phasellus iaculis neque
260
+ - Purus sodales ultricies
261
+ - Vestibulum laoreet porttitor sem
262
+ - Ac tristique libero volutpat at
263
+ + Faucibus porta lacus fringilla vel
264
+ + Aenean sit amet erat nunc
265
+ + Eget porttitor lorem
266
+
267
+ And this HTML
268
+
269
+ ```html
270
+ <ul>
271
+ <li>Lorem ipsum dolor sit amet</li>
272
+ <li>Consectetur adipiscing elit</li>
273
+ <li>Integer molestie lorem at massa</li>
274
+ <li>Facilisis in pretium nisl aliquet</li>
275
+ <li>Nulla volutpat aliquam velit
276
+ <ul>
277
+ <li>Phasellus iaculis neque</li>
278
+ <li>Purus sodales ultricies</li>
279
+ <li>Vestibulum laoreet porttitor sem</li>
280
+ <li>Ac tristique libero volutpat at</li>
281
+ </ul>
282
+ </li>
283
+ <li>Faucibus porta lacus fringilla vel</li>
284
+ <li>Aenean sit amet erat nunc</li>
285
+ <li>Eget porttitor lorem</li>
286
+ </ul>
287
+ ```
288
+
289
+ ### Ordered
290
+
291
+ A list of items in which the order of items does explicitly matter.
292
+
293
+ ```markdown
294
+ 1. Lorem ipsum dolor sit amet
295
+ 2. Consectetur adipiscing elit
296
+ 3. Integer molestie lorem at massa
297
+ 4. Facilisis in pretium nisl aliquet
298
+ 5. Nulla volutpat aliquam velit
299
+ 6. Faucibus porta lacus fringilla vel
300
+ 7. Aenean sit amet erat nunc
301
+ 8. Eget porttitor lorem
302
+ ```
303
+ Renders to:
304
+
305
+ 1. Lorem ipsum dolor sit amet
306
+ 2. Consectetur adipiscing elit
307
+ 3. Integer molestie lorem at massa
308
+ 4. Facilisis in pretium nisl aliquet
309
+ 5. Nulla volutpat aliquam velit
310
+ 6. Faucibus porta lacus fringilla vel
311
+ 7. Aenean sit amet erat nunc
312
+ 8. Eget porttitor lorem
313
+
314
+ And this HTML:
315
+
316
+ ```html
317
+ <ol>
318
+ <li>Lorem ipsum dolor sit amet</li>
319
+ <li>Consectetur adipiscing elit</li>
320
+ <li>Integer molestie lorem at massa</li>
321
+ <li>Facilisis in pretium nisl aliquet</li>
322
+ <li>Nulla volutpat aliquam velit</li>
323
+ <li>Faucibus porta lacus fringilla vel</li>
324
+ <li>Aenean sit amet erat nunc</li>
325
+ <li>Eget porttitor lorem</li>
326
+ </ol>
327
+ ```
328
+
329
+ **TIP**: If you just use `1.` for each number, Markdown will automatically number each item. For example:
330
+
331
+ ```markdown
332
+ 1. Lorem ipsum dolor sit amet
333
+ 1. Consectetur adipiscing elit
334
+ 1. Integer molestie lorem at massa
335
+ 1. Facilisis in pretium nisl aliquet
336
+ 1. Nulla volutpat aliquam velit
337
+ 1. Faucibus porta lacus fringilla vel
338
+ 1. Aenean sit amet erat nunc
339
+ 1. Eget porttitor lorem
340
+ ```
341
+
342
+ Renders to:
343
+
344
+ 1. Lorem ipsum dolor sit amet
345
+ 2. Consectetur adipiscing elit
346
+ 3. Integer molestie lorem at massa
347
+ 4. Facilisis in pretium nisl aliquet
348
+ 5. Nulla volutpat aliquam velit
349
+ 6. Faucibus porta lacus fringilla vel
350
+ 7. Aenean sit amet erat nunc
351
+ 8. Eget porttitor lorem
352
+
353
+ ## Code
354
+
355
+ ### Inline code
356
+ Wrap inline snippets of code with `` ` ``.
357
+
358
+ ```markdown
359
+ In this example, `<section></section>` should be wrapped as **code**.
360
+ ```
361
+
362
+ Renders to:
363
+
364
+ In this example, `<section></section>` should be wrapped with **code**.
365
+
366
+ HTML:
367
+
368
+ ```html
369
+ <p>In this example, <code>&lt;section&gt;&lt;/section&gt;</code> should be wrapped with <strong>code</strong>.</p>
370
+ ```
371
+
372
+ ### Indented code
373
+
374
+ Or indent several lines of code by at least four spaces, as in:
375
+
376
+ <pre>
377
+ // Some comments
378
+ line 1 of code
379
+ line 2 of code
380
+ line 3 of code
381
+ </pre>
382
+
383
+ Renders to:
384
+
385
+ // Some comments
386
+ line 1 of code
387
+ line 2 of code
388
+ line 3 of code
389
+
390
+ HTML:
391
+
392
+ ```html
393
+ <pre>
394
+ <code>
395
+ // Some comments
396
+ line 1 of code
397
+ line 2 of code
398
+ line 3 of code
399
+ </code>
400
+ </pre>
401
+ ```
402
+
403
+
404
+ ### Block code "fences"
405
+
406
+ Use "fences" ```` ``` ```` to block in multiple lines of code.
407
+
408
+ <pre>
409
+ ``` markup
410
+ Sample text here...
411
+ ```
412
+ </pre>
413
+
414
+
415
+ ```
416
+ Sample text here...
417
+ ```
418
+
419
+ HTML:
420
+
421
+ ```html
422
+ <pre>
423
+ <code>Sample text here...</code>
424
+ </pre>
425
+ ```
426
+
427
+ ### Syntax highlighting
428
+
429
+ GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
430
+
431
+ <pre>
432
+ ```js
433
+ grunt.initConfig({
434
+ assemble: {
435
+ options: {
436
+ assets: 'docs/assets',
437
+ data: 'src/data/*.{json,yml}',
438
+ helpers: 'src/custom-helpers.js',
439
+ partials: ['src/partials/**/*.{hbs,md}']
440
+ },
441
+ pages: {
442
+ options: {
443
+ layout: 'default.hbs'
444
+ },
445
+ files: {
446
+ './': ['src/templates/pages/index.hbs']
447
+ }
448
+ }
449
+ }
450
+ };
451
+ ```
452
+ </pre>
453
+
454
+ Renders to:
455
+
456
+ ```js
457
+ grunt.initConfig({
458
+ assemble: {
459
+ options: {
460
+ assets: 'docs/assets',
461
+ data: 'src/data/*.{json,yml}',
462
+ helpers: 'src/custom-helpers.js',
463
+ partials: ['src/partials/**/*.{hbs,md}']
464
+ },
465
+ pages: {
466
+ options: {
467
+ layout: 'default.hbs'
468
+ },
469
+ files: {
470
+ './': ['src/templates/pages/index.hbs']
471
+ }
472
+ }
473
+ }
474
+ };
475
+ ```
476
+
477
+ ## Tables
478
+ Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
479
+
480
+
481
+ ```markdown
482
+ | Option | Description |
483
+ | ------ | ----------- |
484
+ | data | path to data files to supply the data that will be passed into templates. |
485
+ | engine | engine to be used for processing templates. Handlebars is the default. |
486
+ | ext | extension to be used for dest files. |
487
+ ```
488
+
489
+ Renders to:
490
+
491
+ | Option | Description |
492
+ | ------ | ----------- |
493
+ | data | path to data files to supply the data that will be passed into templates. |
494
+ | engine | engine to be used for processing templates. Handlebars is the default. |
495
+ | ext | extension to be used for dest files. |
496
+
497
+ And this HTML:
498
+
499
+ ```html
500
+ <table>
501
+ <tr>
502
+ <th>Option</th>
503
+ <th>Description</th>
504
+ </tr>
505
+ <tr>
506
+ <td>data</td>
507
+ <td>path to data files to supply the data that will be passed into templates.</td>
508
+ </tr>
509
+ <tr>
510
+ <td>engine</td>
511
+ <td>engine to be used for processing templates. Handlebars is the default.</td>
512
+ </tr>
513
+ <tr>
514
+ <td>ext</td>
515
+ <td>extension to be used for dest files.</td>
516
+ </tr>
517
+ </table>
518
+ ```
519
+
520
+ ### Right aligned text
521
+
522
+ Adding a colon on the right side of the dashes below any heading will right align text for that column.
523
+
524
+ ```markdown
525
+ | Option | Description |
526
+ | ------:| -----------:|
527
+ | data | path to data files to supply the data that will be passed into templates. |
528
+ | engine | engine to be used for processing templates. Handlebars is the default. |
529
+ | ext | extension to be used for dest files. |
530
+ ```
531
+
532
+ | Option | Description |
533
+ | ------:| -----------:|
534
+ | data | path to data files to supply the data that will be passed into templates. |
535
+ | engine | engine to be used for processing templates. Handlebars is the default. |
536
+ | ext | extension to be used for dest files. |
537
+
538
+ ## Links
539
+
540
+ ### Basic link
541
+
542
+ ```markdown
543
+ [Assemble](http://assemble.io)
544
+ ```
545
+
546
+ Renders to (hover over the link, there is no tooltip):
547
+
548
+ [Assemble](http://assemble.io)
549
+
550
+ HTML:
551
+
552
+ ```html
553
+ <a href="http://assemble.io">Assemble</a>
554
+ ```
555
+
556
+
557
+ ### Add a title
558
+
559
+ ```markdown
560
+ [Upstage](https://github.com/upstage/ "Visit Upstage!")
561
+ ```
562
+
563
+ Renders to (hover over the link, there should be a tooltip):
564
+
565
+ [Upstage](https://github.com/upstage/ "Visit Upstage!")
566
+
567
+ HTML:
568
+
569
+ ```html
570
+ <a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>
571
+ ```
572
+
573
+ ### Named Anchors
574
+
575
+ Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:
576
+
577
+ ```markdown
578
+ # Table of Contents
579
+ * [Chapter 1](#chapter-1)
580
+ * [Chapter 2](#chapter-2)
581
+ * [Chapter 3](#chapter-3)
582
+ ```
583
+ will jump to these sections:
584
+
585
+ ```markdown
586
+ ## Chapter 1 <a id="chapter-1"></a>
587
+ Content for chapter one.
588
+
589
+ ## Chapter 2 <a id="chapter-2"></a>
590
+ Content for chapter one.
591
+
592
+ ## Chapter 3 <a id="chapter-3"></a>
593
+ Content for chapter one.
594
+ ```
595
+ **NOTE** that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.
596
+
597
+
598
+ ## Images {#images}
599
+ Images have a similar syntax to links but include a preceding exclamation point.
600
+
601
+ ```markdown
602
+ ![Minion](https://octodex.github.com/images/minion.png)
603
+ ```
604
+ ![Minion](https://octodex.github.com/images/minion.png)
605
+
606
+ or
607
+ ```markdown
608
+ ![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
609
+ ```
610
+ ![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
611
+
612
+ Like links, Images also have a footnote style syntax
613
+
614
+ ### Alternative usage : note images
615
+
616
+ ```markdown
617
+ ![Alt text][id]
618
+ ```
619
+ ![Alt text][id]
620
+
621
+ With a reference later in the document defining the URL location:
622
+
623
+ [id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
624
+
625
+ [id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
626
+
627
+ ### Resizing image
628
+
629
+ Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).
630
+
631
+ ```markdown
632
+ ![Minion](https://octodex.github.com/images/minion.png?width=20pc)
633
+ ```
634
+
635
+ ![Minion](https://octodex.github.com/images/minion.png?width=20pc)
636
+
637
+ ```markdown
638
+ ![Minion](https://octodex.github.com/images/minion.png?height=50px)
639
+ ```
640
+
641
+ ![Minion](https://octodex.github.com/images/minion.png?height=50px)
642
+
643
+ ```markdown
644
+ ![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px)
645
+ ```
646
+
647
+ ![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px)
648
+
649
+ ### Add CSS classes
650
+
651
+ Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and `border` are available but you could define other ones.
652
+
653
+ ```markdown
654
+ ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow)
655
+ ```
656
+ ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=shadow)
657
+
658
+ ```markdown
659
+ ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border)
660
+ ```
661
+ ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border)
662
+
663
+ ```markdown
664
+ ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow)
665
+ ```
666
+ ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border,shadow)