rbcli 0.2.10 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (444) hide show
  1. checksums.yaml +4 -4
  2. data/.rakeTasks +7 -0
  3. data/.rbenv-gemsets +1 -0
  4. data/CHANGELOG.md +46 -0
  5. data/Gemfile.lock +66 -48
  6. data/README.md +4 -4
  7. data/docs/404.html +54 -670
  8. data/docs/advanced/automatic_updates/index.html +998 -651
  9. data/docs/advanced/command_types/index.html +1022 -742
  10. data/docs/advanced/distributed_state_locking/index.html +998 -635
  11. data/docs/advanced/hooks/index.html +1011 -691
  12. data/docs/advanced/index.html +1140 -0
  13. data/docs/advanced/index.xml +113 -0
  14. data/docs/advanced/interactive_commands/index.html +1001 -653
  15. data/docs/advanced/logging/index.html +1006 -655
  16. data/docs/advanced/remote_execution/index.html +1010 -666
  17. data/docs/advanced/state_storage/index.html +1009 -721
  18. data/docs/advanced/user_config_files/index.html +981 -626
  19. data/docs/categories/index.html +1146 -0
  20. data/docs/categories/index.xml +10 -0
  21. data/docs/css/atom-one-dark-reasonable.css +77 -0
  22. data/docs/css/auto-complete.css +47 -0
  23. data/docs/css/featherlight.min.css +8 -0
  24. data/docs/css/fontawesome-all.min.css +1 -0
  25. data/docs/css/hugo-theme.css +254 -0
  26. data/docs/css/hybrid.css +102 -0
  27. data/docs/css/nucleus.css +615 -0
  28. data/docs/css/perfect-scrollbar.min.css +2 -0
  29. data/docs/css/tags.css +49 -0
  30. data/docs/css/theme-blue.css +111 -0
  31. data/docs/css/theme-green.css +111 -0
  32. data/docs/css/theme-red.css +111 -0
  33. data/docs/css/theme.css +1136 -0
  34. data/docs/development/changelog/index.html +1389 -0
  35. data/docs/development/code_of_conduct/index.html +973 -670
  36. data/docs/development/contributing/index.html +989 -583
  37. data/docs/development/index.html +1140 -0
  38. data/docs/development/index.xml +50 -0
  39. data/docs/development/license/index.html +973 -559
  40. data/docs/fonts/Inconsolata.eot +0 -0
  41. data/docs/fonts/Inconsolata.svg +1 -0
  42. data/docs/fonts/Inconsolata.ttf +0 -0
  43. data/docs/fonts/Inconsolata.woff +0 -0
  44. data/docs/fonts/Novecentosanswide-Normal-webfont.eot +0 -0
  45. data/docs/fonts/Novecentosanswide-Normal-webfont.svg +1 -0
  46. data/docs/fonts/Novecentosanswide-Normal-webfont.ttf +0 -0
  47. data/docs/fonts/Novecentosanswide-Normal-webfont.woff +0 -0
  48. data/docs/fonts/Novecentosanswide-Normal-webfont.woff2 +0 -0
  49. data/docs/fonts/Novecentosanswide-UltraLight-webfont.eot +0 -0
  50. data/docs/fonts/Novecentosanswide-UltraLight-webfont.svg +1 -0
  51. data/docs/fonts/Novecentosanswide-UltraLight-webfont.ttf +0 -0
  52. data/docs/fonts/Novecentosanswide-UltraLight-webfont.woff +0 -0
  53. data/docs/fonts/Novecentosanswide-UltraLight-webfont.woff2 +0 -0
  54. data/docs/fonts/Work_Sans_200.eot +0 -0
  55. data/docs/fonts/Work_Sans_200.svg +1 -0
  56. data/docs/fonts/Work_Sans_200.ttf +0 -0
  57. data/docs/fonts/Work_Sans_200.woff +0 -0
  58. data/docs/fonts/Work_Sans_200.woff2 +0 -0
  59. data/docs/fonts/Work_Sans_300.eot +0 -0
  60. data/docs/fonts/Work_Sans_300.svg +1 -0
  61. data/docs/fonts/Work_Sans_300.ttf +0 -0
  62. data/docs/fonts/Work_Sans_300.woff +0 -0
  63. data/docs/fonts/Work_Sans_300.woff2 +0 -0
  64. data/docs/fonts/Work_Sans_500.eot +0 -0
  65. data/docs/fonts/Work_Sans_500.svg +1 -0
  66. data/docs/fonts/Work_Sans_500.ttf +0 -0
  67. data/docs/fonts/Work_Sans_500.woff +0 -0
  68. data/docs/fonts/Work_Sans_500.woff2 +0 -0
  69. data/docs/images/clippy.svg +1 -0
  70. data/docs/images/favicon.png +0 -0
  71. data/docs/images/gopher-404.jpg +0 -0
  72. data/docs/imported/changelog/index.html +1208 -1020
  73. data/docs/imported/index.html +1191 -0
  74. data/docs/imported/index.xml +23 -0
  75. data/docs/index.html +925 -558
  76. data/docs/index.json +183 -0
  77. data/docs/index.xml +208 -0
  78. data/docs/js/auto-complete.js +3 -0
  79. data/docs/js/clipboard.min.js +7 -0
  80. data/docs/js/featherlight.min.js +9 -0
  81. data/docs/js/highlight.pack.js +6 -0
  82. data/docs/js/html5shiv-printshiv.min.js +4 -0
  83. data/docs/js/hugo-learn.js +94 -0
  84. data/docs/js/jquery-3.3.1.min.js +2 -0
  85. data/docs/js/jquery.sticky.js +288 -0
  86. data/docs/js/learn.js +459 -0
  87. data/docs/js/lunr.min.js +6 -0
  88. data/docs/js/modernizr.custom-3.6.0.js +3 -0
  89. data/docs/js/perfect-scrollbar.jquery.min.js +2 -0
  90. data/docs/js/perfect-scrollbar.min.js +2 -0
  91. data/docs/js/search.js +93 -0
  92. data/docs/mermaid/mermaid.css +277 -0
  93. data/docs/mermaid/mermaid.dark.css +278 -0
  94. data/docs/mermaid/mermaid.forest.css +356 -0
  95. data/docs/mermaid/mermaid.js +8 -0
  96. data/docs/quick_reference/index.html +1246 -0
  97. data/docs/quick_reference/index.xml +11 -0
  98. data/docs/sitemap.xml +82 -108
  99. data/docs/tags/index.html +1146 -0
  100. data/docs/tags/index.xml +10 -0
  101. data/docs/tutorial/10-getting_started/index.html +994 -662
  102. data/docs/tutorial/20-project_layout/index.html +1013 -722
  103. data/docs/tutorial/30-your_first_command/index.html +1055 -734
  104. data/docs/tutorial/40-options_parameters_and_arguments/index.html +1139 -881
  105. data/docs/tutorial/50-publishing/index.html +984 -671
  106. data/docs/tutorial/index.html +1140 -0
  107. data/docs/tutorial/index.xml +67 -0
  108. data/docs/webfonts/fa-brands-400.eot +0 -0
  109. data/docs/webfonts/fa-brands-400.svg +1 -0
  110. data/docs/webfonts/fa-brands-400.ttf +0 -0
  111. data/docs/webfonts/fa-brands-400.woff +0 -0
  112. data/docs/webfonts/fa-brands-400.woff2 +0 -0
  113. data/docs/webfonts/fa-regular-400.eot +0 -0
  114. data/docs/webfonts/fa-regular-400.svg +1 -0
  115. data/docs/webfonts/fa-regular-400.ttf +0 -0
  116. data/docs/webfonts/fa-regular-400.woff +0 -0
  117. data/docs/webfonts/fa-regular-400.woff2 +0 -0
  118. data/docs/webfonts/fa-solid-900.eot +0 -0
  119. data/docs/webfonts/fa-solid-900.svg +1 -0
  120. data/docs/webfonts/fa-solid-900.ttf +0 -0
  121. data/docs/webfonts/fa-solid-900.woff +0 -0
  122. data/docs/webfonts/fa-solid-900.woff2 +0 -0
  123. data/docs/whoami/index.html +965 -555
  124. data/docs/whoami/index.xml +11 -0
  125. data/docs-src/archetypes/default.md +6 -0
  126. data/docs-src/config.toml +37 -0
  127. data/docs-src/{docs/index.md → content/_index.md} +4 -4
  128. data/docs-src/content/advanced/_index.md +11 -0
  129. data/docs-src/{docs → content}/advanced/automatic_updates.md +6 -2
  130. data/docs-src/{docs → content}/advanced/command_types.md +8 -4
  131. data/docs-src/{docs → content}/advanced/distributed_state_locking.md +6 -2
  132. data/docs-src/{docs → content}/advanced/hooks.md +6 -2
  133. data/docs-src/{docs → content}/advanced/interactive_commands.md +5 -1
  134. data/docs-src/{docs → content}/advanced/logging.md +6 -2
  135. data/docs-src/{docs → content}/advanced/remote_execution.md +5 -1
  136. data/docs-src/{docs → content}/advanced/state_storage.md +6 -3
  137. data/docs-src/{docs → content}/advanced/user_config_files.md +5 -1
  138. data/docs-src/content/development/_index.md +11 -0
  139. data/docs-src/{docs/imported → content/development}/changelog.md +82 -6
  140. data/docs-src/{docs → content}/development/code_of_conduct.md +8 -1
  141. data/docs-src/{docs → content}/development/contributing.md +16 -1
  142. data/docs-src/{docs → content}/development/license.md +9 -2
  143. data/docs-src/{docs/imported/quick_reference.md → content/quick_reference/_index.md} +10 -3
  144. data/docs-src/{docs → content}/tutorial/10-getting_started.md +7 -1
  145. data/docs-src/{docs → content}/tutorial/20-project_layout.md +10 -2
  146. data/docs-src/{docs → content}/tutorial/30-your_first_command.md +10 -4
  147. data/docs-src/{docs → content}/tutorial/40-options_parameters_and_arguments.md +9 -3
  148. data/docs-src/{docs → content}/tutorial/50-publishing.md +9 -3
  149. data/docs-src/content/tutorial/_index.md +11 -0
  150. data/docs-src/{docs/whoami.md → content/whoami/_index.md} +11 -5
  151. data/docs-src/layouts/partials/logo.html +3 -0
  152. data/docs-src/makesite.sh +33 -7
  153. data/docs-src/mkdocs-archived.tar.gz +0 -0
  154. data/docs-src/runsite.sh +6 -1
  155. data/docs-src/themes/hugo-theme-learn/.editorconfig +16 -0
  156. data/docs-src/themes/hugo-theme-learn/.gitignore +3 -0
  157. data/docs-src/themes/hugo-theme-learn/.grenrc.yml +25 -0
  158. data/docs-src/themes/hugo-theme-learn/CHANGELOG.md +226 -0
  159. data/docs-src/themes/hugo-theme-learn/LICENSE.md +22 -0
  160. data/docs-src/themes/hugo-theme-learn/README.md +97 -0
  161. data/docs-src/themes/hugo-theme-learn/archetypes/chapter.md +13 -0
  162. data/docs-src/themes/hugo-theme-learn/archetypes/default.md +7 -0
  163. data/docs-src/themes/hugo-theme-learn/exampleSite/LICENSE.md +20 -0
  164. data/docs-src/themes/hugo-theme-learn/exampleSite/config.toml +102 -0
  165. data/docs-src/themes/hugo-theme-learn/exampleSite/content/_index.en.md +41 -0
  166. data/docs-src/themes/hugo-theme-learn/exampleSite/content/_index.fr.md +43 -0
  167. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.en.md +12 -0
  168. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.fr.md +12 -0
  169. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.zh.md +12 -0
  170. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.en.md +60 -0
  171. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.fr.md +56 -0
  172. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.en.md +102 -0
  173. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.fr.md +100 -0
  174. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/images/chapter.png +0 -0
  175. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.en.md +11 -0
  176. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.fr.md +11 -0
  177. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/images/magic.gif +0 -0
  178. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.en.md +194 -0
  179. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.fr.md +194 -0
  180. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/blue-variant.png +0 -0
  181. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/green-variant.png +0 -0
  182. data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/red-variant.png +0 -0
  183. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/_index.en.md +12 -0
  184. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/_index.fr.md +12 -0
  185. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.en.md +57 -0
  186. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.fr.md +57 -0
  187. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/_index.en.md +78 -0
  188. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/_index.fr.md +78 -0
  189. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/images/i18n-menu.gif +0 -0
  190. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/icons.en.md +41 -0
  191. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.en.md +692 -0
  192. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.fr.md +666 -0
  193. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/menushortcuts.en.md +109 -0
  194. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/menushortcuts.fr.md +109 -0
  195. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.en.md +166 -0
  196. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.fr.md +146 -0
  197. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/frontmatter-icon.png +0 -0
  198. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/pages-chapter.png +0 -0
  199. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/pages-default.png +0 -0
  200. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/syntaxhighlight.en.md +89 -0
  201. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/tags.en.md +39 -0
  202. data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/tags.fr.md +40 -0
  203. data/docs-src/themes/hugo-theme-learn/exampleSite/content/credits.en.md +28 -0
  204. data/docs-src/themes/hugo-theme-learn/exampleSite/content/credits.fr.md +28 -0
  205. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/_index.en.md +16 -0
  206. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/_index.fr.md +16 -0
  207. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/BachGavotteShort.mp3 +0 -0
  208. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf +0 -0
  209. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf +0 -0
  210. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/hugo.png +0 -0
  211. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4 +0 -0
  212. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.md +85 -0
  213. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/BachGavotteShort.mp3 +0 -0
  214. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/Carroll_AliceAuPaysDesMerveilles.pdf +0 -0
  215. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/adivorciarsetoca00cape.pdf +0 -0
  216. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/hugo.png +0 -0
  217. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/movieselectricsheep-flock-244-32500-2.mp4 +0 -0
  218. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.md +85 -0
  219. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.en.md +16 -0
  220. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.fr.md +16 -0
  221. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.en.md +45 -0
  222. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.fr.md +45 -0
  223. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/_index.en.md +6 -0
  224. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/_index.fr.md +6 -0
  225. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en.md +6 -0
  226. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.fr.md +6 -0
  227. 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
  228. 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
  229. 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
  230. 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
  231. 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
  232. 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
  233. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/_index.en.md +11 -0
  234. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/_index.fr.md +11 -0
  235. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/test3.en.md +6 -0
  236. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/test3.fr.md +6 -0
  237. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-3/_index.en.md +6 -0
  238. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-3/_index.fr.md +6 -0
  239. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-4/_index.en.md +7 -0
  240. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-4/_index.fr.md +7 -0
  241. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/test.en.md +6 -0
  242. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/test.fr.md +6 -0
  243. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/expand.en.md +45 -0
  244. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/expand.fr.md +45 -0
  245. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/mermaid.en.md +283 -0
  246. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/mermaid.fr.md +283 -0
  247. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.en.md +62 -0
  248. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.fr.md +62 -0
  249. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/siteparam.en.md +23 -0
  250. data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/siteparam.fr.md +23 -0
  251. data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.en.md +13 -0
  252. data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.fr.md +14 -0
  253. data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/custom-footer.html +10 -0
  254. data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/logo.html +39 -0
  255. data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/menu-footer.html +14 -0
  256. data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/shortcodes/ghcontributors.html +31 -0
  257. data/docs-src/themes/hugo-theme-learn/exampleSite/static/css/theme-mine.css +104 -0
  258. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.eot +0 -0
  259. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.svg +1 -0
  260. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.ttf +0 -0
  261. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.woff +0 -0
  262. data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.woff2 +0 -0
  263. data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/inteliver_docs.png +0 -0
  264. data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/tat.png +0 -0
  265. data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/tshark_dev.png +0 -0
  266. data/docs-src/themes/hugo-theme-learn/i18n/ar.toml +26 -0
  267. data/docs-src/themes/hugo-theme-learn/i18n/de.toml +26 -0
  268. data/docs-src/themes/hugo-theme-learn/i18n/en.toml +26 -0
  269. data/docs-src/themes/hugo-theme-learn/i18n/es.toml +26 -0
  270. data/docs-src/themes/hugo-theme-learn/i18n/fr.toml +26 -0
  271. data/docs-src/themes/hugo-theme-learn/i18n/hi.toml +26 -0
  272. data/docs-src/themes/hugo-theme-learn/i18n/id.toml +26 -0
  273. data/docs-src/themes/hugo-theme-learn/i18n/ja.toml +26 -0
  274. data/docs-src/themes/hugo-theme-learn/i18n/nl.toml +26 -0
  275. data/docs-src/themes/hugo-theme-learn/i18n/pt.toml +26 -0
  276. data/docs-src/themes/hugo-theme-learn/i18n/ru.toml +26 -0
  277. data/docs-src/themes/hugo-theme-learn/i18n/tr.toml +26 -0
  278. data/docs-src/themes/hugo-theme-learn/i18n/zh-cn.toml +26 -0
  279. data/docs-src/themes/hugo-theme-learn/images/screenshot.png +0 -0
  280. data/docs-src/themes/hugo-theme-learn/images/tn.png +0 -0
  281. data/docs-src/themes/hugo-theme-learn/layouts/404.html +56 -0
  282. data/docs-src/themes/hugo-theme-learn/layouts/_default/list.html +22 -0
  283. data/docs-src/themes/hugo-theme-learn/layouts/_default/single.html +12 -0
  284. data/docs-src/themes/hugo-theme-learn/layouts/index.html +31 -0
  285. data/docs-src/themes/hugo-theme-learn/layouts/index.json +12 -0
  286. data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-comments.html +3 -0
  287. data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-footer.html +5 -0
  288. data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-header.html +5 -0
  289. data/docs-src/themes/hugo-theme-learn/layouts/partials/favicon.html +1 -0
  290. data/docs-src/themes/hugo-theme-learn/layouts/partials/footer.html +77 -0
  291. data/docs-src/themes/hugo-theme-learn/layouts/partials/header.html +111 -0
  292. data/docs-src/themes/hugo-theme-learn/layouts/partials/logo.html +19 -0
  293. data/docs-src/themes/hugo-theme-learn/layouts/partials/menu-footer.html +1 -0
  294. data/docs-src/themes/hugo-theme-learn/layouts/partials/menu.html +151 -0
  295. data/docs-src/themes/hugo-theme-learn/layouts/partials/meta.html +2 -0
  296. data/docs-src/themes/hugo-theme-learn/layouts/partials/search.html +16 -0
  297. data/docs-src/themes/hugo-theme-learn/layouts/partials/tags.html +7 -0
  298. data/docs-src/themes/hugo-theme-learn/layouts/partials/toc.html +5 -0
  299. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/attachments.html +36 -0
  300. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/button.html +14 -0
  301. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/children.html +101 -0
  302. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/expand.html +17 -0
  303. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/mermaid.html +2 -0
  304. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/notice.html +2 -0
  305. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/ref.html +14 -0
  306. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/relref.html +14 -0
  307. data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/siteparam.html +7 -0
  308. data/docs-src/themes/hugo-theme-learn/netlify.toml +23 -0
  309. data/docs-src/themes/hugo-theme-learn/static/css/atom-one-dark-reasonable.css +77 -0
  310. data/docs-src/themes/hugo-theme-learn/static/css/auto-complete.css +47 -0
  311. data/docs-src/themes/hugo-theme-learn/static/css/featherlight.min.css +8 -0
  312. data/docs-src/themes/hugo-theme-learn/static/css/fontawesome-all.min.css +1 -0
  313. data/docs-src/themes/hugo-theme-learn/static/css/hugo-theme.css +254 -0
  314. data/docs-src/themes/hugo-theme-learn/static/css/hybrid.css +102 -0
  315. data/docs-src/themes/hugo-theme-learn/static/css/nucleus.css +615 -0
  316. data/docs-src/themes/hugo-theme-learn/static/css/perfect-scrollbar.min.css +2 -0
  317. data/docs-src/themes/hugo-theme-learn/static/css/tags.css +49 -0
  318. data/docs-src/themes/hugo-theme-learn/static/css/theme-blue.css +111 -0
  319. data/docs-src/themes/hugo-theme-learn/static/css/theme-green.css +111 -0
  320. data/docs-src/themes/hugo-theme-learn/static/css/theme-red.css +111 -0
  321. data/docs-src/themes/hugo-theme-learn/static/css/theme.css +1136 -0
  322. data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.eot +0 -0
  323. data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.svg +1 -0
  324. data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.ttf +0 -0
  325. data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.woff +0 -0
  326. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.eot +0 -0
  327. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.svg +1 -0
  328. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.ttf +0 -0
  329. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.woff +0 -0
  330. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.woff2 +0 -0
  331. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.eot +0 -0
  332. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg +1 -0
  333. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.ttf +0 -0
  334. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff +0 -0
  335. data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff2 +0 -0
  336. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.eot +0 -0
  337. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.svg +1 -0
  338. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.ttf +0 -0
  339. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.woff +0 -0
  340. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.woff2 +0 -0
  341. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.eot +0 -0
  342. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.svg +1 -0
  343. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.ttf +0 -0
  344. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.woff +0 -0
  345. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.woff2 +0 -0
  346. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.eot +0 -0
  347. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.svg +1 -0
  348. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.ttf +0 -0
  349. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.woff +0 -0
  350. data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.woff2 +0 -0
  351. data/docs-src/themes/hugo-theme-learn/static/images/clippy.svg +1 -0
  352. data/docs-src/themes/hugo-theme-learn/static/images/favicon.png +0 -0
  353. data/docs-src/themes/hugo-theme-learn/static/images/gopher-404.jpg +0 -0
  354. data/docs-src/themes/hugo-theme-learn/static/js/auto-complete.js +3 -0
  355. data/docs-src/themes/hugo-theme-learn/static/js/clipboard.min.js +7 -0
  356. data/docs-src/themes/hugo-theme-learn/static/js/featherlight.min.js +9 -0
  357. data/docs-src/themes/hugo-theme-learn/static/js/highlight.pack.js +6 -0
  358. data/docs-src/themes/hugo-theme-learn/static/js/hugo-learn.js +94 -0
  359. data/docs-src/themes/hugo-theme-learn/static/js/jquery-3.3.1.min.js +2 -0
  360. data/docs-src/themes/hugo-theme-learn/static/js/jquery.sticky.js +288 -0
  361. data/docs-src/themes/hugo-theme-learn/static/js/learn.js +459 -0
  362. data/docs-src/themes/hugo-theme-learn/static/js/lunr.min.js +6 -0
  363. data/docs-src/themes/hugo-theme-learn/static/js/modernizr.custom-3.6.0.js +3 -0
  364. data/docs-src/themes/hugo-theme-learn/static/js/perfect-scrollbar.jquery.min.js +2 -0
  365. data/docs-src/themes/hugo-theme-learn/static/js/perfect-scrollbar.min.js +2 -0
  366. data/docs-src/themes/hugo-theme-learn/static/js/search.js +93 -0
  367. data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.css +277 -0
  368. data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.dark.css +278 -0
  369. data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.forest.css +356 -0
  370. data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.js +8 -0
  371. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.eot +0 -0
  372. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.svg +1 -0
  373. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.ttf +0 -0
  374. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.woff +0 -0
  375. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.woff2 +0 -0
  376. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.eot +0 -0
  377. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.svg +1 -0
  378. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.ttf +0 -0
  379. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.woff +0 -0
  380. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.woff2 +0 -0
  381. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.eot +0 -0
  382. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.svg +1 -0
  383. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.ttf +0 -0
  384. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.woff +0 -0
  385. data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.woff2 +0 -0
  386. data/docs-src/themes/hugo-theme-learn/theme.toml +21 -0
  387. data/docs-src/themes/hugo-theme-learn/wercker.yml +16 -0
  388. data/exe/rbcli +1 -0
  389. data/lib/rbcli/configuration/configurate_blocks/me.rb +5 -5
  390. data/lib/rbcli/engine/command.rb +3 -2
  391. data/lib/rbcli/util/deprecation_warning.rb +21 -4
  392. data/lib/rbcli/util/msg.rb +0 -1
  393. data/lib/rbcli/version.rb +1 -1
  394. data/lib/rbcli-tool/project.rb +6 -2
  395. data/rbcli.gemspec +12 -13
  396. data/skeletons/project/.rakeTasks +7 -0
  397. data/skeletons/project/Gemfile +1 -1
  398. data/skeletons/project/application/commands/scripts/script.sh +6 -1
  399. data/skeletons/project/config/general.rb +1 -1
  400. data/skeletons/project/exe/executable +1 -3
  401. data/skeletons/project/lib/lib.erb +9 -0
  402. data/skeletons/project/spec/spec_helper.rb +7 -7
  403. data/skeletons/project/spec/untitled_spec.rb +6 -6
  404. data/skeletons/project/untitled.gemspec +30 -30
  405. metadata +384 -98
  406. data/docs/assets/fonts/font-awesome.css +0 -4
  407. data/docs/assets/fonts/material-icons.css +0 -13
  408. data/docs/assets/fonts/specimen/FontAwesome.ttf +0 -0
  409. data/docs/assets/fonts/specimen/FontAwesome.woff +0 -0
  410. data/docs/assets/fonts/specimen/FontAwesome.woff2 +0 -0
  411. data/docs/assets/fonts/specimen/MaterialIcons-Regular.ttf +0 -0
  412. data/docs/assets/fonts/specimen/MaterialIcons-Regular.woff +0 -0
  413. data/docs/assets/fonts/specimen/MaterialIcons-Regular.woff2 +0 -0
  414. data/docs/assets/images/favicon.png +0 -0
  415. data/docs/assets/images/icons/bitbucket.1b09e088.svg +0 -20
  416. data/docs/assets/images/icons/github.f0b8504a.svg +0 -18
  417. data/docs/assets/images/icons/gitlab.6dd19c00.svg +0 -38
  418. data/docs/assets/javascripts/application.583bbe55.js +0 -1
  419. data/docs/assets/javascripts/lunr/lunr.da.js +0 -1
  420. data/docs/assets/javascripts/lunr/lunr.de.js +0 -1
  421. data/docs/assets/javascripts/lunr/lunr.du.js +0 -1
  422. data/docs/assets/javascripts/lunr/lunr.es.js +0 -1
  423. data/docs/assets/javascripts/lunr/lunr.fi.js +0 -1
  424. data/docs/assets/javascripts/lunr/lunr.fr.js +0 -1
  425. data/docs/assets/javascripts/lunr/lunr.hu.js +0 -1
  426. data/docs/assets/javascripts/lunr/lunr.it.js +0 -1
  427. data/docs/assets/javascripts/lunr/lunr.jp.js +0 -1
  428. data/docs/assets/javascripts/lunr/lunr.multi.js +0 -1
  429. data/docs/assets/javascripts/lunr/lunr.no.js +0 -1
  430. data/docs/assets/javascripts/lunr/lunr.pt.js +0 -1
  431. data/docs/assets/javascripts/lunr/lunr.ro.js +0 -1
  432. data/docs/assets/javascripts/lunr/lunr.ru.js +0 -1
  433. data/docs/assets/javascripts/lunr/lunr.stemmer.support.js +0 -1
  434. data/docs/assets/javascripts/lunr/lunr.sv.js +0 -1
  435. data/docs/assets/javascripts/lunr/lunr.tr.js +0 -1
  436. data/docs/assets/javascripts/lunr/tinyseg.js +0 -1
  437. data/docs/assets/javascripts/modernizr.1aa3b519.js +0 -1
  438. data/docs/assets/stylesheets/application-palette.22915126.css +0 -1176
  439. data/docs/assets/stylesheets/application.451f80e5.css +0 -2552
  440. data/docs/imported/quick_reference/index.html +0 -1120
  441. data/docs/search/search_index.json +0 -1
  442. data/docs/sitemap.xml.gz +0 -0
  443. data/docs-src/mkdocs.yml +0 -79
  444. data/skeletons/project/lib/.keep +0 -0
@@ -0,0 +1,109 @@
1
+ ---
2
+ date: 2016-04-09T16:50:16+02:00
3
+ title: Menu extra shortcuts
4
+ weight: 25
5
+ ---
6
+
7
+ You can define additional menu entries or shortcuts in the navigation menu without any link to content.
8
+
9
+ ## Basic configuration
10
+
11
+ Edit the website configuration `config.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add.
12
+
13
+ Example from the current website:
14
+
15
+ [[menu.shortcuts]]
16
+ name = "<i class='fab fa-github'></i> Github repo"
17
+ identifier = "ds"
18
+ url = "https://github.com/matcornic/hugo-theme-learn"
19
+ weight = 10
20
+
21
+ [[menu.shortcuts]]
22
+ name = "<i class='fas fa-camera'></i> Showcases"
23
+ url = "/showcase"
24
+ weight = 11
25
+
26
+ [[menu.shortcuts]]
27
+ name = "<i class='fas fa-bookmark'></i> Hugo Documentation"
28
+ identifier = "hugodoc"
29
+ url = "https://gohugo.io/"
30
+ weight = 20
31
+
32
+ [[menu.shortcuts]]
33
+ name = "<i class='fas fa-bullhorn'></i> Credits"
34
+ url = "/credits"
35
+ weight = 30
36
+
37
+ By default, shortcuts are preceded by a title. This title can be disabled by setting `disableShortcutsTitle=true`.
38
+ However, if you want to keep the title but change its value, it can be overriden by changing your local i18n translation string configuration.
39
+
40
+ For example, in your local `i18n/en.toml` file, add the following content
41
+
42
+ [Shortcuts-Title]
43
+ other = "<Your value>"
44
+
45
+ Read more about [hugo menu](https://gohugo.io/extras/menus/) and [hugo i18n translation strings](https://gohugo.io/content-management/multilingual/#translation-of-strings)
46
+
47
+ ## Configuration for Multilingual mode {#i18n}
48
+
49
+ When using a multilingual website, you can set different menus for each language. In the `config.toml` file, prefix your menu configuration by `Languages.<language-id>`.
50
+
51
+
52
+ Example from the current website:
53
+
54
+ [Languages]
55
+ [Languages.en]
56
+ title = "Documentation for Hugo Learn Theme"
57
+ weight = 1
58
+ languageName = "English"
59
+
60
+ [[Languages.en.menu.shortcuts]]
61
+ name = "<i class='fab fa-github'></i> Github repo"
62
+ identifier = "ds"
63
+ url = "https://github.com/matcornic/hugo-theme-learn"
64
+ weight = 10
65
+
66
+ [[Languages.en.menu.shortcuts]]
67
+ name = "<i class='fas fa-camera'></i> Showcases"
68
+ url = "/showcase"
69
+ weight = 11
70
+
71
+ [[Languages.en.menu.shortcuts]]
72
+ name = "<i class='fas fa-bookmark'></i> Hugo Documentation"
73
+ identifier = "hugodoc"
74
+ url = "https://gohugo.io/"
75
+ weight = 20
76
+
77
+ [[Languages.en.menu.shortcuts]]
78
+ name = "<i class='fas fa-bullhorn'></i> Credits"
79
+ url = "/credits"
80
+ weight = 30
81
+
82
+ [Languages.fr]
83
+ title = "Documentation du thème Hugo Learn"
84
+ weight = 2
85
+ languageName = "Français"
86
+
87
+ [[Languages.fr.menu.shortcuts]]
88
+ name = "<i class='fab fa-github'></i> Repo Github"
89
+ identifier = "ds"
90
+ url = "https://github.com/matcornic/hugo-theme-learn"
91
+ weight = 10
92
+
93
+ [[Languages.fr.menu.shortcuts]]
94
+ name = "<i class='fas fa-camera'></i> Vitrine"
95
+ url = "/showcase"
96
+ weight = 11
97
+
98
+ [[Languages.fr.menu.shortcuts]]
99
+ name = "<i class='fas fa-bookmark'></i> Documentation Hugo"
100
+ identifier = "hugodoc"
101
+ url = "https://gohugo.io/"
102
+ weight = 20
103
+
104
+ [[Languages.fr.menu.shortcuts]]
105
+ name = "<i class='fas fa-bullhorn'></i> Crédits"
106
+ url = "/credits"
107
+ weight = 30
108
+
109
+ Read more about [hugo menu](https://gohugo.io/extras/menus/) and [hugo multilingual menus](https://gohugo.io/content-management/multilingual/#menus)
@@ -0,0 +1,109 @@
1
+ ---
2
+ date: 2016-04-09T16:50:16+02:00
3
+ title: Raccourcis du menu
4
+ weight: 25
5
+ ---
6
+
7
+ Vous pouvez définir des entrées ou raccourcis supplémentaires dans le menu sans avoir besoin d'être lié à un contenu du site.
8
+
9
+ ## Configuration simple
10
+
11
+ Editez le fichier de configuration `config.toml` et ajoutez une entrée `[[menu.shortcuts]]` pour chaque lien que vous voulez ajouter.
12
+
13
+ Exemple pour ce site:
14
+
15
+ [[menu.shortcuts]]
16
+ name = "<i class='fab fa-github'></i> Github repo"
17
+ identifier = "ds"
18
+ url = "https://github.com/matcornic/hugo-theme-learn"
19
+ weight = 10
20
+
21
+ [[menu.shortcuts]]
22
+ name = "<i class='fas fa-camera'></i> Showcases"
23
+ url = "/showcase"
24
+ weight = 11
25
+
26
+ [[menu.shortcuts]]
27
+ name = "<i class='fas fa-bookmark'></i> Hugo Documentation"
28
+ identifier = "hugodoc"
29
+ url = "https://gohugo.io/"
30
+ weight = 20
31
+
32
+ [[menu.shortcuts]]
33
+ name = "<i class='fas fa-bullhorn'></i> Credits"
34
+ url = "/credits"
35
+ weight = 30
36
+
37
+ Par défaut, les raccourcis sont précédés par un titre. Ce titre peut être désactivé en ajouter le paramètre `disableShortcutsTitle=true` dans la section `params` de votre `config.toml`.
38
+ Cependant, si vous voulez garder le titre mais changer sa valeur, vous pouvez modifier votre configuration multilangue locale en changeant les *translation string*.
39
+
40
+ Par exemple, dans votre fichier local `i18n/en.toml`, ajouter le contenu
41
+
42
+ [Shortcuts-Title]
43
+ other = "<Votre valeur>"
44
+
45
+ Plus d'infos sur [les menus Hugo](https://gohugo.io/extras/menus/) et sur [les translations strings](https://gohugo.io/content-management/multilingual/#translation-of-strings)
46
+
47
+ ## Configuration pour le mode multi-langue {#i18n}
48
+
49
+ Quand vous utilisez un site multi-langue, vous pouvez avoir des menus différents pour chaque langage. Dans le fichier de configuration `config.toml`, préfixez votre configuration par `Languages.<language-id>`.
50
+
51
+
52
+ Par exemple, avec ce site :
53
+
54
+ [Languages]
55
+ [Languages.en]
56
+ title = "Documentation for Hugo Learn Theme"
57
+ weight = 1
58
+ languageName = "English"
59
+
60
+ [[Languages.en.menu.shortcuts]]
61
+ name = "<i class='fab fa-github'></i> Github repo"
62
+ identifier = "ds"
63
+ url = "https://github.com/matcornic/hugo-theme-learn"
64
+ weight = 10
65
+
66
+ [[Languages.en.menu.shortcuts]]
67
+ name = "<i class='fas fa-camera'></i> Showcases"
68
+ url = "/showcase"
69
+ weight = 11
70
+
71
+ [[Languages.en.menu.shortcuts]]
72
+ name = "<i class='fas fa-bookmark'></i> Hugo Documentation"
73
+ identifier = "hugodoc"
74
+ url = "https://gohugo.io/"
75
+ weight = 20
76
+
77
+ [[Languages.en.menu.shortcuts]]
78
+ name = "<i class='fas fa-bullhorn'></i> Credits"
79
+ url = "/credits"
80
+ weight = 30
81
+
82
+ [Languages.fr]
83
+ title = "Documentation du thème Hugo Learn"
84
+ weight = 2
85
+ languageName = "Français"
86
+
87
+ [[Languages.fr.menu.shortcuts]]
88
+ name = "<i class='fab fa-github'></i> Repo Github"
89
+ identifier = "ds"
90
+ url = "https://github.com/matcornic/hugo-theme-learn"
91
+ weight = 10
92
+
93
+ [[Languages.fr.menu.shortcuts]]
94
+ name = "<i class='fas fa-camera'></i> Vitrine"
95
+ url = "/showcase"
96
+ weight = 11
97
+
98
+ [[Languages.fr.menu.shortcuts]]
99
+ name = "<i class='fas fa-bookmark'></i> Documentation Hugo"
100
+ identifier = "hugodoc"
101
+ url = "https://gohugo.io/"
102
+ weight = 20
103
+
104
+ [[Languages.fr.menu.shortcuts]]
105
+ name = "<i class='fas fa-bullhorn'></i> Crédits"
106
+ url = "/credits"
107
+ weight = 30
108
+
109
+ Plus d'infos sur [les menus Hugo](https://gohugo.io/extras/menus/) et les [menus multi-langue Hugo](https://gohugo.io/content-management/multilingual/#menus)
@@ -0,0 +1,166 @@
1
+ ---
2
+ date: 2016-04-09T16:50:16+02:00
3
+ title: Pages organization
4
+ weight: 5
5
+ ---
6
+
7
+ In **Hugo**, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.
8
+
9
+ ## Folders
10
+
11
+ Organize your site like [any other Hugo project](https://gohugo.io/content/organization/). Typically, you will have a *content* folder with all your pages.
12
+
13
+ content
14
+ ├── level-one
15
+ │ ├── level-two
16
+ │ │ ├── level-three
17
+ │ │ │ ├── level-four
18
+ │ │ │ │ ├── _index.md <-- /level-one/level-two/level-three/level-four
19
+ │ │ │ │ ├── page-4-a.md <-- /level-one/level-two/level-three/level-four/page-4-a
20
+ │ │ │ │ ├── page-4-b.md <-- /level-one/level-two/level-three/level-four/page-4-b
21
+ │ │ │ │ └── page-4-c.md <-- /level-one/level-two/level-three/level-four/page-4-c
22
+ │ │ │ ├── _index.md <-- /level-one/level-two/level-three
23
+ │ │ │ ├── page-3-a.md <-- /level-one/level-two/level-three/page-3-a
24
+ │ │ │ ├── page-3-b.md <-- /level-one/level-two/level-three/page-3-b
25
+ │ │ │ └── page-3-c.md <-- /level-one/level-two/level-three/page-3-c
26
+ │ │ ├── _index.md <-- /level-one/level-two
27
+ │ │ ├── page-2-a.md <-- /level-one/level-two/page-2-a
28
+ │ │ ├── page-2-b.md <-- /level-one/level-two/page-2-b
29
+ │ │ └── page-2-c.md <-- /level-one/level-two/page-2-c
30
+ │ ├── _index.md <-- /level-one
31
+ │ ├── page-1-a.md <-- /level-one/page-1-a
32
+ │ ├── page-1-b.md <-- /level-one/page-1-b
33
+ │ └── page-1-c.md <-- /level-one/page-1-c
34
+ ├── _index.md <-- /
35
+ └── page-top.md <-- /page-top
36
+
37
+ {{% notice note %}}
38
+ `_index.md` is required in each folder, it’s your “folder home page”
39
+ {{% /notice %}}
40
+
41
+ ## Types
42
+
43
+ **Hugo-theme-learn** defines two types of pages. *Default* and *Chapter*. Both can be used at any level of the documentation, the only difference being layout display.
44
+
45
+ A **Chapter** displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found under it.
46
+ You can define any HTML as prefix for the menu. In the example below, it's just a number but that could be an [icon](https://fortawesome.github.io/Font-Awesome/).
47
+
48
+ ![Chapter page](/en/cont/pages/images/pages-chapter.png?width=50pc)
49
+
50
+ ```markdown
51
+ +++
52
+ title = "Basics"
53
+ chapter = true
54
+ weight = 5
55
+ pre = "<b>1. </b>"
56
+ +++
57
+
58
+ ### Chapter 1
59
+
60
+ # Basics
61
+
62
+ Discover what this Hugo theme is all about and the core-concepts behind it.
63
+ ```
64
+
65
+ To tell **Hugo-theme-learn** to consider a page as a chapter, set `chapter=true` in the Front Matter of the page.
66
+
67
+ A **Default** page is any other content page.
68
+
69
+ ![Default page](/en/cont/pages/images/pages-default.png?width=50pc)
70
+
71
+ ```toml
72
+ +++
73
+ title = "Installation"
74
+ weight = 15
75
+ +++
76
+ ```
77
+
78
+ The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
79
+
80
+ ## Create your project
81
+
82
+ Hugo provides a `new` command to create a new website.
83
+
84
+ ```
85
+ hugo new site <new_project>
86
+ ```
87
+
88
+ **Hugo-theme-learn** provides [archetypes]({{< relref "cont/archetypes.en.md" >}}) to help you create this kind of pages.
89
+
90
+ ## Front Matter configuration
91
+
92
+ Each Hugo page has to define a [Front Matter](https://gohugo.io/content/front-matter/) in *yaml*, *toml* or *json*.
93
+
94
+ **Hugo-theme-learn** uses the following parameters on top of Hugo ones :
95
+
96
+ ```toml
97
+ +++
98
+ # Table of content (toc) is enabled by default. Set this parameter to true to disable it.
99
+ # Note: Toc is always disabled for chapter pages
100
+ disableToc = "false"
101
+ # If set, this will be used for the page's menu entry (instead of the `title` attribute)
102
+ menuTitle = ""
103
+ # The title of the page in menu will be prefixed by this HTML content
104
+ pre = ""
105
+ # The title of the page in menu will be postfixed by this HTML content
106
+ post = ""
107
+ # Set the page as a chapter, changing the way it's displayed
108
+ chapter = false
109
+ # Hide a menu entry by setting this to true
110
+ hidden = false
111
+ # Display name of this page modifier. If set, it will be displayed in the footer.
112
+ LastModifierDisplayName = ""
113
+ # Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer
114
+ LastModifierEmail = ""
115
+ +++
116
+ ```
117
+
118
+ ### Add icon to a menu entry
119
+
120
+ In the page frontmatter, add a `pre` param to insert any HTML code before the menu label. The example below uses the Github icon.
121
+
122
+ ```toml
123
+ +++
124
+ title = "Github repo"
125
+ pre = "<i class='fab fa-github'></i> "
126
+ +++
127
+ ```
128
+
129
+ ![Title with icon](/en/cont/pages/images/frontmatter-icon.png)
130
+
131
+ ### Ordering sibling menu/page entries
132
+
133
+ Hugo provides a [flexible way](https://gohugo.io/content/ordering/) to handle order for your pages.
134
+
135
+ The simplest way is to set `weight` parameter to a number.
136
+
137
+ ```toml
138
+ +++
139
+ title = "My page"
140
+ weight = 5
141
+ +++
142
+ ```
143
+
144
+ ### Using a custom title for menu entries
145
+
146
+ By default, **Hugo-theme-learn** will use a page's `title` attribute for the menu item (or `linkTitle` if defined).
147
+
148
+ But a page's title has to be descriptive on its own while the menu is a hierarchy.
149
+ We've added the `menuTitle` parameter for that purpose:
150
+
151
+ For example (for a page named `content/install/linux.md`):
152
+
153
+ ```toml
154
+ +++
155
+ title = "Install on Linux"
156
+ menuTitle = "Linux"
157
+ +++
158
+ ```
159
+
160
+ ## Homepage
161
+
162
+ To configure your home page, you basically have three choices:
163
+
164
+ 1. Create an `_index.md` document in `content` folder and fill the file with *Markdown content*
165
+ 2. Create an `index.html` file in the `static` folder and fill the file with *HTML content*
166
+ 3. Configure your server to automatically redirect home page to one your documentation page
@@ -0,0 +1,146 @@
1
+ ---
2
+ date: 2016-04-09T16:50:16+02:00
3
+ title: Organisation des pages
4
+ weight: 5
5
+ ---
6
+
7
+ Dans **Hugo**, les pages sont le cœur de votre site. Une fois configurées, les pages sont la valeur ajoutée de votre site de documentation.
8
+
9
+ ## Dossiers
10
+
11
+ Organisez votre site comme n'importe quel autre [projet Hugo](https://gohugo.io/content/organization/). Typiquement, vous allez avoir un dossier *content* avec vos pages.
12
+
13
+ content
14
+ ├── niveau-un
15
+ │ ├── niveau-deux
16
+ │ │ ├── niveau-trois
17
+ │ │ │ ├── niveau-quatre
18
+ │ │ │ │ ├── _index.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre
19
+ │ │ │ │ ├── page-4-a.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre/page-4-a
20
+ │ │ │ │ ├── page-4-b.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre/page-4-b
21
+ │ │ │ │ └── page-4-c.md <-- /niveau-un/niveau-deux/niveau-trois/niveau-quatre/page-4-c
22
+ │ │ │ ├── _index.md <-- /niveau-un/niveau-deux/niveau-trois
23
+ │ │ │ ├── page-3-a.md <-- /niveau-un/niveau-deux/niveau-trois/page-3-a
24
+ │ │ │ ├── page-3-b.md <-- /niveau-un/niveau-deux/niveau-trois/page-3-b
25
+ │ │ │ └── page-3-c.md <-- /niveau-un/niveau-deux/niveau-trois/page-3-c
26
+ │ │ ├── _index.md <-- /niveau-un/niveau-deux
27
+ │ │ ├── page-2-a.md <-- /niveau-un/niveau-deux/page-2-a
28
+ │ │ ├── page-2-b.md <-- /niveau-un/niveau-deux/page-2-b
29
+ │ │ └── page-2-c.md <-- /niveau-un/niveau-deux/page-2-c
30
+ │ ├── _index.md <-- /niveau-un
31
+ │ ├── page-1-a.md <-- /niveau-un/page-1-a
32
+ │ ├── page-1-b.md <-- /niveau-un/page-1-b
33
+ │ └── page-1-c.md <-- /niveau-un/page-1-c
34
+ ├── _index.md <-- /
35
+ └── premiere-page.md <-- /premiere-page
36
+
37
+ {{% notice note %}}
38
+ Le fichier `_index.md` est obligatoire dans chaque dossier, c'est en quelque sorte votre page d'accueil pour le dossier.
39
+ {{% /notice %}}
40
+
41
+ ## Types
42
+
43
+ **Hugo-theme-learn** définit deux types de pages. *Défaut* et *Chapitre*. Les deux sont utilisables à n'importe quel niveau du site, la seule différence est dans l'affichage.
44
+
45
+ Un **Chapitre** affiche une page vouée à être une introduction pour un ensemble de pages filles. Habituellement, il va seulement contenir un titre et un résumé de la section.
46
+ Vous pouvez définir n'importe quel contenu HTML comme préfixe de l'entrée du menu. Dans l'exemple ci-dessous, c'est juste un nombre mais vous pourriez utiliser une [icône](https://fortawesome.github.io/Font-Awesome/).
47
+
48
+ ![Page Chapitre](/en/cont/pages/images/pages-chapter.png?width=50pc)
49
+
50
+ ```markdown
51
+ +++
52
+ title = "Démarrage"
53
+ weight = 5
54
+ pre = "<b>1. </b>"
55
+ chapter = true
56
+ +++
57
+
58
+ ### Chapitre 1
59
+
60
+ # Démarrage
61
+
62
+ Découvrez comment utiliser ce thème Hugo et apprenez en les concepts
63
+ ```
64
+
65
+ Pour dire à **Hugo-theme-learn** de considérer la page comme un chapitre, configure `chapter=true` dans le Front Matter de la page.
66
+
67
+ Une page **Défaut** est n'importe quelle autre page.
68
+
69
+ ![Page défaut](/en/cont/pages/images/pages-default.png?width=50pc)
70
+
71
+ +++
72
+ title = "Installation"
73
+ weight = 15
74
+ +++
75
+
76
+ The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
77
+
78
+ ## Create your project
79
+
80
+ Hugo provides a `new` command to create a new website.
81
+
82
+ ```
83
+ hugo new site <new_project>
84
+ ```
85
+
86
+ **Hugo-theme-learn** fournit des [archétypes]({{< relref "cont/archetypes.fr.md" >}}) pour vous aider à créer ce type de pages.
87
+
88
+ ## Configuration des Front Matter
89
+
90
+ Chaque page Hugo doit définir un [Front Matter](https://gohugo.io/content/front-matter/) dans le format *yaml*, *toml* ou *json*.
91
+
92
+ **Hugo-theme-learn** utilise les paramètres suivant en plus de ceux définis par Hugo:
93
+
94
+ ```toml
95
+ +++
96
+ # Le Sommaire (table of content = toc) est activé par défaut. Modifier ce paramètre à true pour le désactiver.
97
+ # Note: Le sommaire est toujours désactivé pour les chapitres
98
+ disableToc = "false"
99
+ # Le titre de la page dans le menu sera préfixé par ce contentu HTML
100
+ pre = ""
101
+ # Le titre de la page dans le menu sera suffixé par ce contentu HTML
102
+ post = ""
103
+ # Modifier le type de la page pour changer l'affichage
104
+ chapter = false
105
+ # Cache la page du menu
106
+ hidden = false
107
+ # Nom de la personne qui a modifié la page. Quand configuré, sera affiché dans le pied de page.
108
+ LastModifierDisplayName = ""
109
+ # Email de la personne qui a modifié la page. Quand configuré, sera affiché dans le pied de page.
110
+ LastModifierEmail = ""
111
+ +++
112
+ ```
113
+
114
+ ### Ajouter une icône à une entrée du menu
115
+
116
+ Dans le Front Matter, ajouter un paramètre `pre` pour insérer du code HTML qui s'affichera avant le label du menu. L'exemple ci-dessous utilise l'icône de Github.
117
+
118
+ ```toml
119
+ +++
120
+ title = "Repo Github"
121
+ pre = "<i class='fab fa-github'></i> "
122
+ +++
123
+ ```
124
+
125
+ ![Titre avec icône](/en/cont/pages/images/frontmatter-icon.png)
126
+
127
+ ### Ordonner les entrées dans le menu
128
+
129
+ Hugo permet de modifier facilement [l'ordre des menu](https://gohugo.io/content/ordering/).
130
+
131
+ La manière la plus simple est de configurer le paramètre `weight` avec un nombre.
132
+
133
+ ```toml
134
+ +++
135
+ title = "Ma page"
136
+ weight = 5
137
+ +++
138
+ ```
139
+
140
+ ## Page d'accueil
141
+
142
+ Pour configurer votre page d'accueil, vous avez trois choix:
143
+
144
+ 1. Créer une page `_index.md` dans le dossier `content` et remplissez le fichier avec du *contenu Markdown*
145
+ 2. Créer une page `index.html` dans le dossier `static` et remplissez le fichier avec du *contenu HTML*
146
+ 3. Configurez votre serveur pour automatiquement rediriger la page d'accueil vers l'une de vos pages.
@@ -0,0 +1,89 @@
1
+ ---
2
+ date: 2020-06-01T13:31:12+01:00
3
+ title: Code highlighting
4
+ weight: 16
5
+ ---
6
+
7
+ Learn theme uses [highlight.js](https://highlightjs.org/) to provide code syntax highlighting.
8
+
9
+ ## Markdown syntax
10
+
11
+ Wrap the code block with three backticks and the name of the language. Highlight will try to auto detect the language if one is not provided.
12
+
13
+ <!-- markdownlint-disable MD046 -->
14
+ ```plaintext
15
+ ```json
16
+ [
17
+ {
18
+ "title": "apples",
19
+ "count": [12000, 20000],
20
+ "description": {"text": "...", "sensitive": false}
21
+ },
22
+ {
23
+ "title": "oranges",
24
+ "count": [17500, null],
25
+ "description": {"text": "...", "sensitive": false}
26
+ }
27
+ ]
28
+ ```
29
+ ```
30
+ <!-- markdownlint-disable MD046 -->
31
+
32
+ Renders to:
33
+
34
+ ```json
35
+ [
36
+ {
37
+ "title": "apples",
38
+ "count": [12000, 20000],
39
+ "description": {"text": "...", "sensitive": false}
40
+ },
41
+ {
42
+ "title": "oranges",
43
+ "count": [17500, null],
44
+ "description": {"text": "...", "sensitive": false}
45
+ }
46
+ ]
47
+ ```
48
+
49
+ ## Supported languages
50
+
51
+ Learn theme ships with its own version of highlight.js to support offline browsing. The included package supports 38 common languages, as described on the [highlight.js download page](https://highlightjs.org/download/).
52
+
53
+ ## Identifying failed language detection
54
+
55
+ Highlight will write a warning to the browser console if a requested language was not found. For example, the following code block references an imaginary language `foo`. An error will be output to the console on this page.
56
+
57
+ ```plaintext
58
+ ```foo
59
+ bar
60
+ ```
61
+ ```
62
+
63
+ ```nohighlight
64
+ Could not find the language 'foo', did you forget to load/include a language module?(anonymous) @ highlight.pack.js
65
+ ```
66
+
67
+ ## Supporting additional languages
68
+
69
+ To support languages other than the 38 common languages included in the default highlight.js you will need to download your own version of highlight.js and add it to your site content.
70
+
71
+ ### Download custom highlight.js
72
+
73
+ Visit [https://highlightjs.org/download/](https://highlightjs.org/download/) and select your desired language support. Note that more languages means greater package size.
74
+
75
+ ### Add custom highlight.js to static resources
76
+
77
+ Inside the zip archive downloaded from highlight.js extract the file named `highlight.pack.js`. Move this file to the **new** location
78
+
79
+ ```nohighlight
80
+ static/js/highlight.pack.js
81
+ ```
82
+
83
+ **Do not** replace the existing file at `themes/hugo-theme-learn/static/js/highlight.pack.js`.
84
+
85
+ Including the file in the correct path will override the theme default highlight.pack.js and prevent issues caused in the future if the theme default file is updated.
86
+
87
+ ## Further usage information
88
+
89
+ See [https://highlightjs.org/usage/](https://highlightjs.org/usage/)
@@ -0,0 +1,39 @@
1
+ ---
2
+ date: 2018-11-29T08:41:44+01:00
3
+ title: Tags
4
+ weight: 40
5
+ tags: ["documentation", "tutorial"]
6
+ ---
7
+
8
+ *Learn theme* support one default taxonomy of gohugo: the *tag* feature.
9
+
10
+ ## Configuration
11
+
12
+ Just add tags to any page:
13
+
14
+ ```markdown
15
+ ---
16
+ date: 2018-11-29T08:41:44+01:00
17
+ title: Theme tutorial
18
+ weight: 15
19
+ tags: ["tutorial", "theme"]
20
+ ---
21
+ ```
22
+
23
+ ## Behavior
24
+
25
+
26
+ The tags are displayed at the top of the page, in their insertion order.
27
+
28
+ Each tag is a link to a *Taxonomy* page displaying all the articles with the given tag.
29
+
30
+ ## List all the tags
31
+
32
+ In the `config.toml` file you can add a shortcut to display all the tags
33
+
34
+ ```toml
35
+ [[menu.shortcuts]]
36
+ name = "<i class='fas fa-tags'></i> Tags"
37
+ url = "/tags"
38
+ weight = 30
39
+ ```