rbcli 0.3.3 → 0.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.md +9 -0
- data/LICENSE.txt +5 -670
- data/README.md +64 -160
- data/VERSION +1 -0
- data/exe/rbcli +181 -242
- data/lib/rbcli/components/commands/command.rb +120 -0
- data/lib/rbcli/components/commands/command.rb.erb +55 -0
- data/lib/rbcli/components/commands/command_old.rb +105 -0
- data/lib/rbcli/components/commands/script.rb.erb +43 -0
- data/{lib-sh → lib/rbcli/components/commands/scriptwrapper}/lib-rbcli.sh +29 -34
- data/lib/rbcli/components/commands/scriptwrapper/scriptwrapper.rb +64 -0
- data/lib/rbcli/components/config/backend.rb +104 -0
- data/lib/rbcli/components/config/backends/env.rb +63 -0
- data/lib/rbcli/components/config/backends/helpers/deep_assign.rb +47 -0
- data/lib/rbcli/components/config/backends/ini.rb +53 -0
- data/lib/rbcli/components/config/backends/json.rb +31 -0
- data/lib/rbcli/components/config/backends/null.rb +28 -0
- data/lib/rbcli/components/config/backends/toml.rb +37 -0
- data/lib/rbcli/components/config/backends/yaml.rb +31 -0
- data/lib/rbcli/components/config/component.rb +28 -0
- data/lib/rbcli/components/config/config.rb +110 -0
- data/lib/rbcli/components/config/config_of_death.rb +12 -0
- data/lib/rbcli/components/config/template.rb.erb +34 -0
- data/lib/rbcli/components/core/configurate.rb +63 -0
- data/lib/rbcli/components/core/engine.rb +30 -0
- data/lib/rbcli/components/core/warehouse.rb +18 -0
- data/lib/rbcli/components/envvars/component.rb +20 -0
- data/lib/rbcli/components/envvars/template.rb.erb +24 -0
- data/lib/rbcli/components/hooks/component.rb +36 -0
- data/lib/rbcli/components/hooks/template.rb.erb +20 -0
- data/lib/rbcli/components/logger/component.rb +32 -0
- data/lib/rbcli/components/logger/logger.rb +155 -0
- data/lib/rbcli/components/logger/lolcat/lol.rb +71 -0
- data/lib/rbcli/components/logger/template.rb.erb +40 -0
- data/lib/rbcli/components/parser/component.rb +34 -0
- data/lib/rbcli/{util → components/parser/optimist}/optimist.rb +134 -48
- data/lib/rbcli/components/parser/parser.rb +179 -0
- data/lib/rbcli/components/parser/template.rb.erb +36 -0
- data/lib/rbcli/components/updatechecker/common/common.rb +52 -0
- data/lib/rbcli/components/updatechecker/component.rb +42 -0
- data/lib/rbcli/components/updatechecker/gem_checker.rb +40 -0
- data/lib/rbcli/components/updatechecker/github_checker.rb +46 -0
- data/lib/rbcli/components/updatechecker/template.rb.erb +14 -0
- data/lib/rbcli/util/deprecation_warning.rb +41 -55
- data/lib/rbcli/util/errors.rb +12 -0
- data/lib/rbcli/util/exit.rb +12 -0
- data/lib/rbcli/util/hash_deep_symbolize.rb +50 -41
- data/lib/rbcli/util/string_compression.rb +10 -0
- data/lib/rbcli/version.rb +5 -20
- data/lib/rbcli-tool/helpers.rb +58 -0
- data/lib/rbcli-tool/skeletons/gem.rb.erb +17 -0
- data/lib/rbcli-tool/skeletons/portable.rb.erb +48 -0
- data/lib/rbcli.rb +19 -50
- data/sig/rbcli.rbs +9 -0
- metadata +124 -496
- data/.gitignore +0 -60
- data/.rakeTasks +0 -7
- data/.rbenv-gemsets +0 -1
- data/.travis.yml +0 -5
- data/CHANGELOG.md +0 -193
- data/CODE_OF_CONDUCT.md +0 -74
- data/Gemfile +0 -6
- data/Gemfile.lock +0 -92
- data/Rakefile +0 -10
- data/bin/console +0 -33
- data/bin/setup +0 -28
- data/docs/404.html +0 -59
- data/docs/advanced/automatic_updates/index.html +0 -1174
- data/docs/advanced/command_types/index.html +0 -1262
- data/docs/advanced/distributed_state_locking/index.html +0 -1176
- data/docs/advanced/hooks/index.html +0 -1192
- data/docs/advanced/index.html +0 -1140
- data/docs/advanced/index.xml +0 -75
- data/docs/advanced/interactive_commands/index.html +0 -1177
- data/docs/advanced/logging/index.html +0 -1184
- data/docs/advanced/remote_execution/index.html +0 -1190
- data/docs/advanced/state_storage/index.html +0 -1281
- data/docs/advanced/user_config_files/index.html +0 -1209
- data/docs/categories/index.html +0 -1146
- data/docs/categories/index.xml +0 -11
- data/docs/css/atom-one-dark-reasonable.css +0 -77
- data/docs/css/auto-complete.css +0 -47
- data/docs/css/featherlight.min.css +0 -8
- data/docs/css/fontawesome-all.min.css +0 -1
- data/docs/css/hugo-theme.css +0 -254
- data/docs/css/hybrid.css +0 -102
- data/docs/css/nucleus.css +0 -615
- data/docs/css/perfect-scrollbar.min.css +0 -2
- data/docs/css/tags.css +0 -49
- data/docs/css/theme-blue.css +0 -111
- data/docs/css/theme-green.css +0 -111
- data/docs/css/theme-red.css +0 -111
- data/docs/css/theme.css +0 -1136
- data/docs/development/changelog/index.html +0 -1420
- data/docs/development/code_of_conduct/index.html +0 -1222
- data/docs/development/contributing/index.html +0 -1201
- data/docs/development/index.html +0 -1140
- data/docs/development/index.xml +0 -40
- data/docs/development/license/index.html +0 -1165
- data/docs/fonts/Inconsolata.eot +0 -0
- data/docs/fonts/Inconsolata.svg +0 -1
- data/docs/fonts/Inconsolata.ttf +0 -0
- data/docs/fonts/Inconsolata.woff +0 -0
- data/docs/fonts/Novecentosanswide-Normal-webfont.eot +0 -0
- data/docs/fonts/Novecentosanswide-Normal-webfont.svg +0 -1
- data/docs/fonts/Novecentosanswide-Normal-webfont.ttf +0 -0
- data/docs/fonts/Novecentosanswide-Normal-webfont.woff +0 -0
- data/docs/fonts/Novecentosanswide-Normal-webfont.woff2 +0 -0
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.eot +0 -0
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.svg +0 -1
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.ttf +0 -0
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.woff +0 -0
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.woff2 +0 -0
- data/docs/fonts/Work_Sans_200.eot +0 -0
- data/docs/fonts/Work_Sans_200.svg +0 -1
- data/docs/fonts/Work_Sans_200.ttf +0 -0
- data/docs/fonts/Work_Sans_200.woff +0 -0
- data/docs/fonts/Work_Sans_200.woff2 +0 -0
- data/docs/fonts/Work_Sans_300.eot +0 -0
- data/docs/fonts/Work_Sans_300.svg +0 -1
- data/docs/fonts/Work_Sans_300.ttf +0 -0
- data/docs/fonts/Work_Sans_300.woff +0 -0
- data/docs/fonts/Work_Sans_300.woff2 +0 -0
- data/docs/fonts/Work_Sans_500.eot +0 -0
- data/docs/fonts/Work_Sans_500.svg +0 -1
- data/docs/fonts/Work_Sans_500.ttf +0 -0
- data/docs/fonts/Work_Sans_500.woff +0 -0
- data/docs/fonts/Work_Sans_500.woff2 +0 -0
- data/docs/images/clippy.svg +0 -1
- data/docs/images/favicon.png +0 -0
- data/docs/images/gopher-404.jpg +0 -0
- data/docs/imported/changelog/index.html +0 -1449
- data/docs/imported/index.html +0 -1191
- data/docs/imported/index.xml +0 -23
- data/docs/index.html +0 -1138
- data/docs/index.json +0 -183
- data/docs/index.xml +0 -138
- data/docs/js/auto-complete.js +0 -3
- data/docs/js/clipboard.min.js +0 -7
- data/docs/js/featherlight.min.js +0 -9
- data/docs/js/highlight.pack.js +0 -6
- data/docs/js/html5shiv-printshiv.min.js +0 -4
- data/docs/js/hugo-learn.js +0 -94
- data/docs/js/jquery-3.3.1.min.js +0 -2
- data/docs/js/jquery.sticky.js +0 -288
- data/docs/js/learn.js +0 -459
- data/docs/js/lunr.min.js +0 -6
- data/docs/js/modernizr.custom-3.6.0.js +0 -3
- data/docs/js/perfect-scrollbar.jquery.min.js +0 -2
- data/docs/js/perfect-scrollbar.min.js +0 -2
- data/docs/js/search.js +0 -93
- data/docs/mermaid/mermaid.css +0 -277
- data/docs/mermaid/mermaid.dark.css +0 -278
- data/docs/mermaid/mermaid.forest.css +0 -356
- data/docs/mermaid/mermaid.js +0 -8
- data/docs/quick_reference/index.html +0 -1246
- data/docs/quick_reference/index.xml +0 -12
- data/docs/sitemap.xml +0 -81
- data/docs/tags/index.html +0 -1146
- data/docs/tags/index.xml +0 -11
- data/docs/tutorial/10-getting_started/index.html +0 -1174
- data/docs/tutorial/20-project_layout/index.html +0 -1299
- data/docs/tutorial/30-your_first_command/index.html +0 -1263
- data/docs/tutorial/40-options_parameters_and_arguments/index.html +0 -1384
- data/docs/tutorial/50-publishing/index.html +0 -1187
- data/docs/tutorial/index.html +0 -1140
- data/docs/tutorial/index.xml +0 -47
- data/docs/webfonts/fa-brands-400.eot +0 -0
- data/docs/webfonts/fa-brands-400.svg +0 -1
- data/docs/webfonts/fa-brands-400.ttf +0 -0
- data/docs/webfonts/fa-brands-400.woff +0 -0
- data/docs/webfonts/fa-brands-400.woff2 +0 -0
- data/docs/webfonts/fa-regular-400.eot +0 -0
- data/docs/webfonts/fa-regular-400.svg +0 -1
- data/docs/webfonts/fa-regular-400.ttf +0 -0
- data/docs/webfonts/fa-regular-400.woff +0 -0
- data/docs/webfonts/fa-regular-400.woff2 +0 -0
- data/docs/webfonts/fa-solid-900.eot +0 -0
- data/docs/webfonts/fa-solid-900.svg +0 -1
- data/docs/webfonts/fa-solid-900.ttf +0 -0
- data/docs/webfonts/fa-solid-900.woff +0 -0
- data/docs/webfonts/fa-solid-900.woff2 +0 -0
- data/docs/whoami/index.html +0 -1155
- data/docs/whoami/index.xml +0 -12
- data/docs-src/archetypes/default.md +0 -6
- data/docs-src/config.toml +0 -37
- data/docs-src/content/_index.md +0 -40
- data/docs-src/content/advanced/_index.md +0 -11
- data/docs-src/content/advanced/automatic_updates.md +0 -46
- data/docs-src/content/advanced/command_types.md +0 -148
- data/docs-src/content/advanced/distributed_state_locking.md +0 -37
- data/docs-src/content/advanced/hooks.md +0 -69
- data/docs-src/content/advanced/interactive_commands.md +0 -41
- data/docs-src/content/advanced/logging.md +0 -39
- data/docs-src/content/advanced/remote_execution.md +0 -60
- data/docs-src/content/advanced/state_storage.md +0 -120
- data/docs-src/content/advanced/user_config_files.md +0 -51
- data/docs-src/content/development/_index.md +0 -11
- data/docs-src/content/development/changelog.md +0 -199
- data/docs-src/content/development/code_of_conduct.md +0 -81
- data/docs-src/content/development/contributing.md +0 -88
- data/docs-src/content/development/license.md +0 -17
- data/docs-src/content/quick_reference/_index.md +0 -180
- data/docs-src/content/tutorial/10-getting_started.md +0 -47
- data/docs-src/content/tutorial/20-project_layout.md +0 -123
- data/docs-src/content/tutorial/30-your_first_command.md +0 -132
- data/docs-src/content/tutorial/40-options_parameters_and_arguments.md +0 -282
- data/docs-src/content/tutorial/50-publishing.md +0 -53
- data/docs-src/content/tutorial/_index.md +0 -11
- data/docs-src/content/whoami/_index.md +0 -34
- data/docs-src/layouts/partials/logo.html +0 -3
- data/docs-src/makesite.sh +0 -40
- data/docs-src/mkdocs-archived.tar.gz +0 -0
- data/docs-src/runsite.sh +0 -8
- data/docs-src/themes/hugo-theme-learn/.editorconfig +0 -16
- data/docs-src/themes/hugo-theme-learn/.gitignore +0 -3
- data/docs-src/themes/hugo-theme-learn/.grenrc.yml +0 -25
- data/docs-src/themes/hugo-theme-learn/CHANGELOG.md +0 -226
- data/docs-src/themes/hugo-theme-learn/LICENSE.md +0 -22
- data/docs-src/themes/hugo-theme-learn/README.md +0 -97
- data/docs-src/themes/hugo-theme-learn/archetypes/chapter.md +0 -13
- data/docs-src/themes/hugo-theme-learn/archetypes/default.md +0 -7
- data/docs-src/themes/hugo-theme-learn/exampleSite/LICENSE.md +0 -20
- data/docs-src/themes/hugo-theme-learn/exampleSite/config.toml +0 -102
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/_index.en.md +0 -41
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/_index.fr.md +0 -43
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.en.md +0 -12
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.fr.md +0 -12
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.zh.md +0 -12
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.en.md +0 -60
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.fr.md +0 -56
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.en.md +0 -102
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.fr.md +0 -100
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/images/chapter.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.en.md +0 -11
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.fr.md +0 -11
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/images/magic.gif +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.en.md +0 -194
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.fr.md +0 -194
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/blue-variant.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/green-variant.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/red-variant.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/_index.en.md +0 -12
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/_index.fr.md +0 -12
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.en.md +0 -57
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.fr.md +0 -57
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/_index.en.md +0 -78
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/_index.fr.md +0 -78
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/images/i18n-menu.gif +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/icons.en.md +0 -41
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.en.md +0 -692
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.fr.md +0 -666
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/menushortcuts.en.md +0 -109
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/menushortcuts.fr.md +0 -109
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.en.md +0 -166
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.fr.md +0 -146
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/frontmatter-icon.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/pages-chapter.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/pages-default.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/syntaxhighlight.en.md +0 -89
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/tags.en.md +0 -39
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/tags.fr.md +0 -40
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/credits.en.md +0 -28
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/credits.fr.md +0 -28
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/_index.en.md +0 -16
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/_index.fr.md +0 -16
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/BachGavotteShort.mp3 +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/hugo.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4 +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.md +0 -85
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/BachGavotteShort.mp3 +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/Carroll_AliceAuPaysDesMerveilles.pdf +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/adivorciarsetoca00cape.pdf +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/hugo.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/movieselectricsheep-flock-244-32500-2.mp4 +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.md +0 -85
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.en.md +0 -16
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.fr.md +0 -16
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.en.md +0 -45
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.fr.md +0 -45
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/_index.en.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/_index.fr.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.fr.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.en.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.fr.md +0 -6
- 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 +0 -6
- 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 +0 -6
- 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 +0 -6
- 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 +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/_index.en.md +0 -11
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/_index.fr.md +0 -11
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/test3.en.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/test3.fr.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-3/_index.en.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-3/_index.fr.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-4/_index.en.md +0 -7
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-4/_index.fr.md +0 -7
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/test.en.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/test.fr.md +0 -6
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/expand.en.md +0 -45
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/expand.fr.md +0 -45
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/mermaid.en.md +0 -283
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/mermaid.fr.md +0 -283
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.en.md +0 -62
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.fr.md +0 -62
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/siteparam.en.md +0 -23
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/siteparam.fr.md +0 -23
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.en.md +0 -13
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.fr.md +0 -14
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/custom-footer.html +0 -10
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/logo.html +0 -39
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/menu-footer.html +0 -14
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/shortcodes/ghcontributors.html +0 -31
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/css/theme-mine.css +0 -104
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/inteliver_docs.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/tat.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/tshark_dev.png +0 -0
- data/docs-src/themes/hugo-theme-learn/i18n/ar.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/de.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/en.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/es.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/fr.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/hi.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/id.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/ja.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/nl.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/pt.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/ru.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/tr.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/i18n/zh-cn.toml +0 -26
- data/docs-src/themes/hugo-theme-learn/images/screenshot.png +0 -0
- data/docs-src/themes/hugo-theme-learn/images/tn.png +0 -0
- data/docs-src/themes/hugo-theme-learn/layouts/404.html +0 -56
- data/docs-src/themes/hugo-theme-learn/layouts/_default/list.html +0 -22
- data/docs-src/themes/hugo-theme-learn/layouts/_default/single.html +0 -12
- data/docs-src/themes/hugo-theme-learn/layouts/index.html +0 -31
- data/docs-src/themes/hugo-theme-learn/layouts/index.json +0 -12
- data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-comments.html +0 -3
- data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-footer.html +0 -5
- data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-header.html +0 -5
- data/docs-src/themes/hugo-theme-learn/layouts/partials/favicon.html +0 -1
- data/docs-src/themes/hugo-theme-learn/layouts/partials/footer.html +0 -77
- data/docs-src/themes/hugo-theme-learn/layouts/partials/header.html +0 -111
- data/docs-src/themes/hugo-theme-learn/layouts/partials/logo.html +0 -19
- data/docs-src/themes/hugo-theme-learn/layouts/partials/menu-footer.html +0 -1
- data/docs-src/themes/hugo-theme-learn/layouts/partials/menu.html +0 -151
- data/docs-src/themes/hugo-theme-learn/layouts/partials/meta.html +0 -2
- data/docs-src/themes/hugo-theme-learn/layouts/partials/search.html +0 -16
- data/docs-src/themes/hugo-theme-learn/layouts/partials/tags.html +0 -7
- data/docs-src/themes/hugo-theme-learn/layouts/partials/toc.html +0 -5
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/attachments.html +0 -36
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/button.html +0 -14
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/children.html +0 -101
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/expand.html +0 -17
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/mermaid.html +0 -2
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/notice.html +0 -2
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/ref.html +0 -14
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/relref.html +0 -14
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/siteparam.html +0 -7
- data/docs-src/themes/hugo-theme-learn/netlify.toml +0 -23
- data/docs-src/themes/hugo-theme-learn/static/css/atom-one-dark-reasonable.css +0 -77
- data/docs-src/themes/hugo-theme-learn/static/css/auto-complete.css +0 -47
- data/docs-src/themes/hugo-theme-learn/static/css/featherlight.min.css +0 -8
- data/docs-src/themes/hugo-theme-learn/static/css/fontawesome-all.min.css +0 -1
- data/docs-src/themes/hugo-theme-learn/static/css/hugo-theme.css +0 -254
- data/docs-src/themes/hugo-theme-learn/static/css/hybrid.css +0 -102
- data/docs-src/themes/hugo-theme-learn/static/css/nucleus.css +0 -615
- data/docs-src/themes/hugo-theme-learn/static/css/perfect-scrollbar.min.css +0 -2
- data/docs-src/themes/hugo-theme-learn/static/css/tags.css +0 -49
- data/docs-src/themes/hugo-theme-learn/static/css/theme-blue.css +0 -111
- data/docs-src/themes/hugo-theme-learn/static/css/theme-green.css +0 -111
- data/docs-src/themes/hugo-theme-learn/static/css/theme-red.css +0 -111
- data/docs-src/themes/hugo-theme-learn/static/css/theme.css +0 -1136
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/images/clippy.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/static/images/favicon.png +0 -0
- data/docs-src/themes/hugo-theme-learn/static/images/gopher-404.jpg +0 -0
- data/docs-src/themes/hugo-theme-learn/static/js/auto-complete.js +0 -3
- data/docs-src/themes/hugo-theme-learn/static/js/clipboard.min.js +0 -7
- data/docs-src/themes/hugo-theme-learn/static/js/featherlight.min.js +0 -9
- data/docs-src/themes/hugo-theme-learn/static/js/highlight.pack.js +0 -6
- data/docs-src/themes/hugo-theme-learn/static/js/hugo-learn.js +0 -94
- data/docs-src/themes/hugo-theme-learn/static/js/jquery-3.3.1.min.js +0 -2
- data/docs-src/themes/hugo-theme-learn/static/js/jquery.sticky.js +0 -288
- data/docs-src/themes/hugo-theme-learn/static/js/learn.js +0 -459
- data/docs-src/themes/hugo-theme-learn/static/js/lunr.min.js +0 -6
- data/docs-src/themes/hugo-theme-learn/static/js/modernizr.custom-3.6.0.js +0 -3
- data/docs-src/themes/hugo-theme-learn/static/js/perfect-scrollbar.jquery.min.js +0 -2
- data/docs-src/themes/hugo-theme-learn/static/js/perfect-scrollbar.min.js +0 -2
- data/docs-src/themes/hugo-theme-learn/static/js/search.js +0 -93
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.css +0 -277
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.dark.css +0 -278
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.forest.css +0 -356
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.js +0 -8
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.svg +0 -1
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/theme.toml +0 -21
- data/docs-src/themes/hugo-theme-learn/wercker.yml +0 -16
- data/lib/rbcli/configuration/configurate.rb +0 -85
- data/lib/rbcli/configuration/configurate_blocks/hooks.rb +0 -52
- data/lib/rbcli/configuration/configurate_blocks/me.rb +0 -122
- data/lib/rbcli/configuration/configurate_blocks/storage.rb +0 -50
- data/lib/rbcli/engine/command.rb +0 -251
- data/lib/rbcli/engine/load_project.rb +0 -45
- data/lib/rbcli/engine/parser.rb +0 -116
- data/lib/rbcli/features/autoupdate/common/autoupdate.rb +0 -50
- data/lib/rbcli/features/autoupdate/gem_updater.rb +0 -62
- data/lib/rbcli/features/autoupdate/github_updater.rb +0 -76
- data/lib/rbcli/features/logging.rb +0 -98
- data/lib/rbcli/features/remote_exec.rb +0 -187
- data/lib/rbcli/features/scriptwrapper.rb +0 -75
- data/lib/rbcli/features/userconfig.rb +0 -163
- data/lib/rbcli/state_storage/common/state_storage.rb +0 -138
- data/lib/rbcli/state_storage/localstate.rb +0 -77
- data/lib/rbcli/state_storage/placeholders.rb +0 -29
- data/lib/rbcli/state_storage/remote_state_connectors/dynamodb.rb +0 -272
- data/lib/rbcli/state_storage/remotestate_dynamodb.rb +0 -115
- data/lib/rbcli/util/msg.rb +0 -55
- data/lib/rbcli/util/string_colorize.rb +0 -45
- data/lib/rbcli-tool/generators.rb +0 -105
- data/lib/rbcli-tool/mdless_fix.rb +0 -406
- data/lib/rbcli-tool/project.rb +0 -120
- data/lib/rbcli-tool/util.rb +0 -70
- data/lib/rbcli-tool.rb +0 -37
- data/rbcli.gemspec +0 -73
- data/skeletons/micro/executable +0 -132
- data/skeletons/mini/executable +0 -247
- data/skeletons/project/.gitignore +0 -11
- data/skeletons/project/.rakeTasks +0 -7
- data/skeletons/project/.rbcli +0 -0
- data/skeletons/project/.rspec +0 -3
- data/skeletons/project/CODE_OF_CONDUCT.md +0 -74
- data/skeletons/project/Gemfile +0 -6
- data/skeletons/project/README.md +0 -46
- data/skeletons/project/Rakefile +0 -6
- data/skeletons/project/application/commands/command.erb +0 -28
- data/skeletons/project/application/commands/script.erb +0 -30
- data/skeletons/project/application/commands/scripts/script.sh +0 -60
- data/skeletons/project/application/options.rb +0 -34
- data/skeletons/project/config/autoupdate.rb +0 -35
- data/skeletons/project/config/general.rb +0 -17
- data/skeletons/project/config/logging.rb +0 -19
- data/skeletons/project/config/storage.rb +0 -35
- data/skeletons/project/config/userspace.rb +0 -33
- data/skeletons/project/config/version.rb +0 -3
- data/skeletons/project/exe/executable +0 -53
- data/skeletons/project/hooks/default_action.rb +0 -16
- data/skeletons/project/hooks/first_run.rb +0 -16
- data/skeletons/project/hooks/post_execution.rb +0 -14
- data/skeletons/project/hooks/pre_execution.rb +0 -14
- data/skeletons/project/lib/lib.erb +0 -9
- data/skeletons/project/spec/spec_helper.rb +0 -14
- data/skeletons/project/spec/untitled_spec.rb +0 -9
- data/skeletons/project/untitled.gemspec +0 -40
- data/skeletons/project/userconf/user_defaults.yml +0 -6
- /data/{docs-src/.hugo_build.lock → lib/rbcli/plugins/.keep} +0 -0
@@ -1,60 +0,0 @@
|
|
1
|
-
---
|
2
|
-
date: 2016-04-09T16:50:16+02:00
|
3
|
-
title: Configuration
|
4
|
-
weight: 20
|
5
|
-
---
|
6
|
-
|
7
|
-
## Global site parameters
|
8
|
-
|
9
|
-
On top of [Hugo global configuration](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** lets you define the following parameters in your `config.toml` (here, values are default).
|
10
|
-
|
11
|
-
Note that some of these parameters are explained in details in other sections of this documentation.
|
12
|
-
|
13
|
-
```toml
|
14
|
-
[params]
|
15
|
-
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
|
16
|
-
# Useful to give opportunity to people to create merge request for your doc.
|
17
|
-
# See the config.toml file from this documentation site to have an example.
|
18
|
-
editURL = ""
|
19
|
-
# Author of the site, will be used in meta information
|
20
|
-
author = ""
|
21
|
-
# Description of the site, will be used in meta information
|
22
|
-
description = ""
|
23
|
-
# Shows a checkmark for visited pages on the menu
|
24
|
-
showVisitedLinks = false
|
25
|
-
# Disable search function. It will hide search bar
|
26
|
-
disableSearch = false
|
27
|
-
# Javascript and CSS cache are automatically busted when new version of site is generated.
|
28
|
-
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
|
29
|
-
disableAssetsBusting = false
|
30
|
-
# Set this to true to disable copy-to-clipboard button for inline code.
|
31
|
-
disableInlineCopyToClipBoard = false
|
32
|
-
# A title for shortcuts in menu is set by default. Set this to true to disable it.
|
33
|
-
disableShortcutsTitle = false
|
34
|
-
# When using mulitlingual website, disable the switch language button.
|
35
|
-
disableLanguageSwitchingButton = false
|
36
|
-
# Hide breadcrumbs in the header and only show the current page title
|
37
|
-
disableBreadcrumb = true
|
38
|
-
# Hide Next and Previous page buttons normally displayed full height beside content
|
39
|
-
disableNextPrev = true
|
40
|
-
# Order sections in menu by "weight" or "title". Default to "weight"
|
41
|
-
ordersectionsby = "weight"
|
42
|
-
# Change default color scheme with a variant one. Can be "red", "blue", "green".
|
43
|
-
themeVariant = ""
|
44
|
-
# Provide a list of custom css files to load relative from the `static/` folder in the site root.
|
45
|
-
custom_css = ["css/foo.css", "css/bar.css"]
|
46
|
-
```
|
47
|
-
|
48
|
-
## Activate search
|
49
|
-
|
50
|
-
If not already present, add the follow lines in the same `config.toml` file.
|
51
|
-
|
52
|
-
```toml
|
53
|
-
[outputs]
|
54
|
-
home = [ "HTML", "RSS", "JSON"]
|
55
|
-
```
|
56
|
-
|
57
|
-
Learn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.
|
58
|
-
|
59
|
-
> Hugo generate lunrjs index.json at the root of public folder.
|
60
|
-
> When you build the site with `hugo server`, hugo generates it internally and of course it doesn’t show up in the filesystem
|
@@ -1,56 +0,0 @@
|
|
1
|
-
---
|
2
|
-
date: 2016-04-09T16:50:16+02:00
|
3
|
-
title: Configuration
|
4
|
-
weight: 20
|
5
|
-
---
|
6
|
-
|
7
|
-
## Paramètres globaux du site
|
8
|
-
|
9
|
-
En plus de la [configuration globale d'Hugo](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** vous permet de définir les paramètres suivant dans votre fichier `config.toml` (ci-dessous sont affichées les valeurs par défaut).
|
10
|
-
|
11
|
-
Notez que certains de ces paramètres sont expliqués en détails dans d'autres sections de cette documentation.
|
12
|
-
|
13
|
-
```toml
|
14
|
-
[params]
|
15
|
-
# L'URL préfixe pour éditer la page courante. Ce paramètre affichera un bouton "Modifier cette page" on haut de de chacune des pages.
|
16
|
-
# Pratique pour donner les possibilité à vos utilisateurs de créer une merge request pour votre doc.
|
17
|
-
# Allez voir le fichier config.toml de cette documentation pour avoir un exemple.
|
18
|
-
editURL = ""
|
19
|
-
# Autheur du site, est utilisé dans les informations meta
|
20
|
-
author = ""
|
21
|
-
# Description du site, est utilisé dans les informations meta
|
22
|
-
description = ""
|
23
|
-
# Affiche une icône lorsque la page a été visitée
|
24
|
-
showVisitedLinks = false
|
25
|
-
# Désactive la fonction de recherche. Une valeur à true cache la barre de recherche.
|
26
|
-
disableSearch = false
|
27
|
-
# Par défaut, le cache Javascript et CSS est automatiquement vidé lorsqu'une nouvelle version du site est générée.
|
28
|
-
# Utilisez ce paramètre lorsque vous voulez désactiver ce comportement (c'est parfois incompatible avec certains proxys)
|
29
|
-
disableAssetsBusting = false
|
30
|
-
# Utilisez ce paramètre pour désactiver le bouton copy-to-clipboard pour le code formatté sur une ligne.
|
31
|
-
disableInlineCopyToClipBoard = false
|
32
|
-
# Un titre est défini par défaut lorsque vous utilisez un raccourci dans le menu. Utilisez ce paramètre pour le cacher.
|
33
|
-
disableShortcutsTitle = false
|
34
|
-
# Quand vous utilisez un site multi-langue, utilisez ce paramètre pour désactiver le bouton de changement de langue.
|
35
|
-
disableLanguageSwitchingButton = false
|
36
|
-
# Ordonne les sections dans menu par poids ("weight") ou titre ("title"). Défaut à "weight"
|
37
|
-
ordersectionsby = "weight"
|
38
|
-
# Utilisez ce paramètre pour modifier le schéma de couleur du site. Les valeurs par défaut sont "red", "blue", "green".
|
39
|
-
themeVariant = ""
|
40
|
-
# Fournissez une liste de fichiers css personnalisés à charger par rapport depuis le dossier `static/` à la racine du site.
|
41
|
-
custom_css = ["css/foo.css", "css/bar.css"]
|
42
|
-
```
|
43
|
-
|
44
|
-
## Activer la recherche {#activer-recherche}
|
45
|
-
|
46
|
-
Si ce n'est pas déjà présent, ajoutez les lignes suivantes dans le fichier `config.toml`.
|
47
|
-
|
48
|
-
```toml
|
49
|
-
[outputs]
|
50
|
-
home = [ "HTML", "RSS", "JSON"]
|
51
|
-
```
|
52
|
-
|
53
|
-
Le thème *Learn* utilise les dernières améliorations d'Hugo pour générer un fichier d'index JSON, prêt à être consommé par le moteur de recherche lunr.js.
|
54
|
-
|
55
|
-
> Hugo génère lunrjs index.json à la racine du dossier `public`.
|
56
|
-
> Quand vous générez le site avec `hugo server`, Hugo génère le fichier en mémoire, il n'est donc pas disponible sur le disque.
|
@@ -1,102 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Installation
|
3
|
-
weight: 15
|
4
|
-
---
|
5
|
-
|
6
|
-
The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you learn more about it by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
|
7
|
-
|
8
|
-
## Create your project
|
9
|
-
|
10
|
-
Hugo provides a `new` command to create a new website.
|
11
|
-
|
12
|
-
```
|
13
|
-
hugo new site <new_project>
|
14
|
-
```
|
15
|
-
|
16
|
-
## Install the theme
|
17
|
-
|
18
|
-
Install the **Hugo-theme-learn** theme by following [this documentation](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme)
|
19
|
-
|
20
|
-
This theme's repository is: https://github.com/matcornic/hugo-theme-learn.git
|
21
|
-
|
22
|
-
Alternatively, you can [download the theme as .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) file and extract it in the `themes` directory
|
23
|
-
|
24
|
-
## Basic configuration
|
25
|
-
|
26
|
-
When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (`config.toml`) and set the theme as the default. You can also add the `[outputs]` section to enable the search functionality.
|
27
|
-
|
28
|
-
```toml
|
29
|
-
# Change the default theme to be use when building the site with Hugo
|
30
|
-
theme = "hugo-theme-learn"
|
31
|
-
|
32
|
-
# For search functionality
|
33
|
-
[outputs]
|
34
|
-
home = [ "HTML", "RSS", "JSON"]
|
35
|
-
```
|
36
|
-
|
37
|
-
## Create your first chapter page
|
38
|
-
|
39
|
-
Chapters are pages that contain other child pages. It has a special layout style and usually just contains a _chapter name_, the _title_ and a _brief abstract_ of the section.
|
40
|
-
|
41
|
-
```
|
42
|
-
### Chapter 1
|
43
|
-
|
44
|
-
# Basics
|
45
|
-
|
46
|
-
Discover what this Hugo theme is all about and the core concepts behind it.
|
47
|
-
```
|
48
|
-
|
49
|
-
renders as
|
50
|
-
|
51
|
-
![A Chapter](/en/basics/installation/images/chapter.png?classes=shadow&width=60pc)
|
52
|
-
|
53
|
-
**Hugo-theme-learn** provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command
|
54
|
-
|
55
|
-
```
|
56
|
-
hugo new --kind chapter basics/_index.md
|
57
|
-
```
|
58
|
-
|
59
|
-
By opening the given file, you should see the property `chapter=true` on top, meaning this page is a _chapter_.
|
60
|
-
|
61
|
-
By default all chapters and pages are created as a draft. If you want to render these pages, remove the property `draft: true` from the metadata.
|
62
|
-
|
63
|
-
## Create your first content pages
|
64
|
-
|
65
|
-
Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:
|
66
|
-
|
67
|
-
```
|
68
|
-
hugo new basics/first-content.md
|
69
|
-
hugo new basics/second-content/_index.md
|
70
|
-
```
|
71
|
-
|
72
|
-
Feel free to edit thoses files by adding some sample content and replacing the `title` value in the beginning of the files.
|
73
|
-
|
74
|
-
## Launching the website locally
|
75
|
-
|
76
|
-
Launch by using the following command:
|
77
|
-
|
78
|
-
```
|
79
|
-
hugo serve
|
80
|
-
```
|
81
|
-
|
82
|
-
Go to `http://localhost:1313`
|
83
|
-
|
84
|
-
You should notice three things:
|
85
|
-
|
86
|
-
1. You have a left-side **Basics** menu, containing two submenus with names equal to the `title` properties in the previously created files.
|
87
|
-
2. The home page explains how to customize it by following the instructions.
|
88
|
-
3. When you run `hugo serve`, when the contents of the files change, the page automatically refreshes with the changes. Neat!
|
89
|
-
|
90
|
-
## Build the website
|
91
|
-
|
92
|
-
When your site is ready to deploy, run the following command:
|
93
|
-
|
94
|
-
```
|
95
|
-
hugo
|
96
|
-
```
|
97
|
-
|
98
|
-
A `public` folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.
|
99
|
-
|
100
|
-
{{% notice note %}}
|
101
|
-
This website can be automatically published and hosted with [Netlify](https://www.netlify.com/) (Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). Alternatively, you can use [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/)
|
102
|
-
{{% /notice %}}
|
@@ -1,100 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Installation
|
3
|
-
weight: 15
|
4
|
-
---
|
5
|
-
|
6
|
-
Les étapes suivantes sont là pour vous aider à initialiser votre site. Si vous ne connaissez pas du tout Hugo, il est fortement conseillé de vous entrainer en suivant ce [super tuto pour débutants](https://gohugo.io/overview/quickstart/).
|
7
|
-
|
8
|
-
## Créer votre projet
|
9
|
-
|
10
|
-
Hugo fournit une commande `new` pour créer un nouveau site.
|
11
|
-
|
12
|
-
```
|
13
|
-
hugo new site <new_project>
|
14
|
-
```
|
15
|
-
|
16
|
-
## Installer le thème
|
17
|
-
|
18
|
-
Installer le thème **Hugo-theme-learn** en suivant [cette documentation](https://gohugo.io/themes/installing/)
|
19
|
-
|
20
|
-
Le repo du thème est : https://github.com/matcornic/hugo-theme-learn.git
|
21
|
-
|
22
|
-
Sinon, vous pouvez [télécharger le thème sous forme d'un fichier .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) et extrayez le dans votre dossier de thèmes.
|
23
|
-
|
24
|
-
## Configuration simple
|
25
|
-
|
26
|
-
Lorsque vous générez votre site, vous pouvez définir un thème en utilisant l'option `--theme`. Il est conseillé de modifier votre fichier de configuration `config.toml` and définir votre thème par défaut. En passant, ajoutez les prérequis à l'utilisation de la fonctionnalité de recherche.
|
27
|
-
|
28
|
-
```toml
|
29
|
-
# Modifiez le thème pour qu'il soit utilisé par défaut à chaque génération de site.
|
30
|
-
theme = "hugo-theme-learn"
|
31
|
-
|
32
|
-
# Pour la fonctionnalité de recherche
|
33
|
-
[outputs]
|
34
|
-
home = [ "HTML", "RSS", "JSON"]
|
35
|
-
```
|
36
|
-
|
37
|
-
## Créer votre première page chapitre
|
38
|
-
|
39
|
-
Les *chapitres* sont des pages contenant d'autre pages filles. Elles ont un affichage spécial et contiennent habituellement juste un _nom_ de chapitre, le _titre_ et un _résumé_ de la section.
|
40
|
-
|
41
|
-
```
|
42
|
-
### Chapitre 1
|
43
|
-
|
44
|
-
# Démarrage
|
45
|
-
|
46
|
-
Découvrez comment utiliser ce thème Hugo et apprenez en les concepts
|
47
|
-
```
|
48
|
-
|
49
|
-
s'affiche comme
|
50
|
-
|
51
|
-
![Un chapitre](/en/basics/installation/images/chapter.png?classes=shadow&width=60pc)
|
52
|
-
|
53
|
-
**Hugo-theme-learn** fournit des archétypes pour créer des squelettes pour votre site. Commencez par créer votre premier chapitre avec la commande suivante:
|
54
|
-
|
55
|
-
```
|
56
|
-
hugo new --kind chapter basics/_index.md
|
57
|
-
```
|
58
|
-
|
59
|
-
En ouvrant le fichier généré, vous devriez voir la propriété `chapter=true` en haut, paramètre quit définit que le page est un _chapitre_.
|
60
|
-
|
61
|
-
## Créer votre première page
|
62
|
-
|
63
|
-
Puis, créez votre premier page dans le chapitre précédent. Pour ce faire, il existe deux possibilités :
|
64
|
-
|
65
|
-
```
|
66
|
-
hugo new basics/first-content.md
|
67
|
-
hugo new basics/second-content/_index.md
|
68
|
-
```
|
69
|
-
|
70
|
-
N'hésitez pas à éditer ces fichiers en ajoutant des exemple de contenu et en remplaçant le paramètre `title` au début du fichier.
|
71
|
-
|
72
|
-
## Lancer le site localement
|
73
|
-
|
74
|
-
Lancez la commande suivante :
|
75
|
-
|
76
|
-
```
|
77
|
-
hugo serve
|
78
|
-
```
|
79
|
-
|
80
|
-
Se rendre sur `http://localhost:1313`
|
81
|
-
|
82
|
-
Vous devriez voir trois choses:
|
83
|
-
|
84
|
-
1. Vous avez un menu **Basics** à gauche, qui contient deux sous-menu avec des noms égal au paramètre `title` des fichiers précédemment générés.
|
85
|
-
2. La page d'accueil vous explique comment la modifier. Suivez les instructions.
|
86
|
-
3. Avec la commande `hugo serve`, la page se rafraichit automatiquement à chaque fois que vous sauvegardez. Super !
|
87
|
-
|
88
|
-
## Générez le site
|
89
|
-
|
90
|
-
Quand votre site est prêt à être déployé, lancez la commande suivante:
|
91
|
-
|
92
|
-
```
|
93
|
-
hugo
|
94
|
-
```
|
95
|
-
|
96
|
-
Un dossier `public` a été généré. Il contient tout le contenu statique et les ressources nécessaires pour votre site. Votre site peut maintenant être déployé en utilisant n'importe quel serveur !
|
97
|
-
|
98
|
-
{{% notice note %}}
|
99
|
-
Ce site peut être automatiquement publié et hébergé avec [Netlify](https://www.netlify.com/) ([Plus d'infos](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). Sinon, vous pouvez utiliser les [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/)
|
100
|
-
{{% /notice %}}
|
data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/images/chapter.png
DELETED
Binary file
|
@@ -1,11 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Requirements
|
3
|
-
weight: 10
|
4
|
-
disableToc: true
|
5
|
-
---
|
6
|
-
|
7
|
-
Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.
|
8
|
-
|
9
|
-
Just download latest version of [Hugo binary (> 0.25)](https://gohugo.io/getting-started/installing/) for your OS (Windows, Linux, Mac) : it's that simple.
|
10
|
-
|
11
|
-
![Magic](/en/basics/requirements/images/magic.gif?classes=shadow)
|
@@ -1,11 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Prérequis
|
3
|
-
weight: 10
|
4
|
-
disableToc: true
|
5
|
-
---
|
6
|
-
|
7
|
-
Grâce à la simplicité d'Hugo, cette page est vide car il n'y a quasi pas de prérequis pour utiliser le thème.
|
8
|
-
|
9
|
-
Téléchargez la dernière version du [binaire Hugo (> 0.25)](https://gohugo.io/getting-started/installing/) pour votre Système d'exploitation (Windows, Linux, Mac) : et c'est tout !
|
10
|
-
|
11
|
-
![Magic](/en/basics/requirements/images/magic.gif?classes=shadow)
|
data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/images/magic.gif
DELETED
Binary file
|
data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.en.md
DELETED
@@ -1,194 +0,0 @@
|
|
1
|
-
---
|
2
|
-
date: 2016-04-09T16:50:16+02:00
|
3
|
-
title: Style customization
|
4
|
-
weight: 25
|
5
|
-
---
|
6
|
-
|
7
|
-
**Hugo-theme-learn** has been built to be as configurable as possible by defining multiple [partials](https://gohugo.io/templates/partials/)
|
8
|
-
|
9
|
-
In `themes/hugo-theme-learn/layouts/partials/`, you will find all the partials defined for this theme. If you need to overwrite something, don't change the code directly. Instead [follow this page](https://gohugo.io/themes/customizing/). You'd create a new partial in the `layouts/partials` folder of your local project. This partial will have the priority.
|
10
|
-
|
11
|
-
This theme defines the following partials :
|
12
|
-
|
13
|
-
- *header*: the header of the content page (contains the breadcrumbs). _Not meant to be overwritten_
|
14
|
-
- *custom-header*: custom headers in page. Meant to be overwritten when adding CSS imports. Don't forget to include `style` HTML tag directive in your file
|
15
|
-
- *footer*: the footer of the content page (contains the arrows). _Not meant to be overwritten_
|
16
|
-
- *custom-footer*: custom footer in page. Meant to be overwritten when adding Javacript. Don't forget to include `javascript` HTML tag directive in your file
|
17
|
-
- *favicon*: the favicon
|
18
|
-
- *logo*: the logo, on top left hand corner.
|
19
|
-
- *meta*: HTML meta tags, if you want to change default behavior
|
20
|
-
- *menu*: left menu. _Not meant to be overwritten_
|
21
|
-
- *menu-footer*: footer of the the left menu
|
22
|
-
- *search*: search box
|
23
|
-
- *toc*: table of contents
|
24
|
-
|
25
|
-
## Change the logo
|
26
|
-
|
27
|
-
Create a new file in `layouts/partials/` named `logo.html`. Then write any HTML you want.
|
28
|
-
You could use an `img` HTML tag and reference an image created under the *static* folder, or you could paste a SVG definition !
|
29
|
-
|
30
|
-
{{% notice note %}}
|
31
|
-
The size of the logo will adapt automatically
|
32
|
-
{{% /notice %}}
|
33
|
-
|
34
|
-
## Change the favicon
|
35
|
-
|
36
|
-
If your favicon is a png, just drop off your image in your local `static/images/` folder and name it `favicon.png`
|
37
|
-
|
38
|
-
If you need to change this default behavior, create a new file in `layouts/partials/` named `favicon.html`. Then write something like this:
|
39
|
-
|
40
|
-
```html
|
41
|
-
<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon" />
|
42
|
-
```
|
43
|
-
|
44
|
-
## Change default colors {#theme-variant}
|
45
|
-
|
46
|
-
**Hugo Learn theme** let you choose between 3 native color scheme variants, but feel free to add one yourself ! Default color scheme is based on [Grav Learn Theme](https://learn.getgrav.org/).
|
47
|
-
|
48
|
-
### Red variant
|
49
|
-
|
50
|
-
```toml
|
51
|
-
[params]
|
52
|
-
# Change default color scheme with a variant one. Can be "red", "blue", "green".
|
53
|
-
themeVariant = "red"
|
54
|
-
```
|
55
|
-
|
56
|
-
![Red variant](/en/basics/style-customization/images/red-variant.png?width=60pc)
|
57
|
-
|
58
|
-
### Blue variant
|
59
|
-
|
60
|
-
```toml
|
61
|
-
[params]
|
62
|
-
# Change default color scheme with a variant one. Can be "red", "blue", "green".
|
63
|
-
themeVariant = "blue"
|
64
|
-
```
|
65
|
-
|
66
|
-
![Blue variant](/en/basics/style-customization/images/blue-variant.png?width=60pc)
|
67
|
-
|
68
|
-
### Green variant
|
69
|
-
|
70
|
-
```toml
|
71
|
-
[params]
|
72
|
-
# Change default color scheme with a variant one. Can be "red", "blue", "green".
|
73
|
-
themeVariant = "green"
|
74
|
-
```
|
75
|
-
|
76
|
-
![Green variant](/en/basics/style-customization/images/green-variant.png?width=60pc)
|
77
|
-
|
78
|
-
### 'Yours‘ variant
|
79
|
-
|
80
|
-
First, create a new CSS file in your local `static/css` folder prefixed by `theme` (e.g. with _mine_ theme `static/css/theme-mine.css`). Copy the following content and modify colors in CSS variables.
|
81
|
-
|
82
|
-
```css
|
83
|
-
|
84
|
-
:root{
|
85
|
-
|
86
|
-
--MAIN-TEXT-color:#323232; /* Color of text by default */
|
87
|
-
--MAIN-TITLES-TEXT-color: #5e5e5e; /* Color of titles h2-h3-h4-h5 */
|
88
|
-
--MAIN-LINK-color:#1C90F3; /* Color of links */
|
89
|
-
--MAIN-LINK-HOVER-color:#167ad0; /* Color of hovered links */
|
90
|
-
--MAIN-ANCHOR-color: #1C90F3; /* color of anchors on titles */
|
91
|
-
|
92
|
-
--MENU-HEADER-BG-color:#1C90F3; /* Background color of menu header */
|
93
|
-
--MENU-HEADER-BORDER-color:#33a1ff; /*Color of menu header border */
|
94
|
-
|
95
|
-
--MENU-SEARCH-BG-color:#167ad0; /* Search field background color (by default borders + icons) */
|
96
|
-
--MENU-SEARCH-BOX-color: #33a1ff; /* Override search field border color */
|
97
|
-
--MENU-SEARCH-BOX-ICONS-color: #a1d2fd; /* Override search field icons color */
|
98
|
-
|
99
|
-
--MENU-SECTIONS-ACTIVE-BG-color:#20272b; /* Background color of the active section and its childs */
|
100
|
-
--MENU-SECTIONS-BG-color:#252c31; /* Background color of other sections */
|
101
|
-
--MENU-SECTIONS-LINK-color: #ccc; /* Color of links in menu */
|
102
|
-
--MENU-SECTIONS-LINK-HOVER-color: #e6e6e6; /* Color of links in menu, when hovered */
|
103
|
-
--MENU-SECTION-ACTIVE-CATEGORY-color: #777; /* Color of active category text */
|
104
|
-
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
|
105
|
-
|
106
|
-
--MENU-VISITED-color: #33a1ff; /* Color of 'page visited' icons in menu */
|
107
|
-
--MENU-SECTION-HR-color: #20272b; /* Color of <hr> separator in menu */
|
108
|
-
|
109
|
-
}
|
110
|
-
|
111
|
-
body {
|
112
|
-
color: var(--MAIN-TEXT-color) !important;
|
113
|
-
}
|
114
|
-
|
115
|
-
textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[type="password"]:focus, input[type="search"]:focus, input[type="tel"]:focus, input[type="text"]:focus, input[type="url"]:focus, input[type="color"]:focus, input[type="date"]:focus, input[type="datetime"]:focus, input[type="datetime-local"]:focus, input[type="month"]:focus, input[type="time"]:focus, input[type="week"]:focus, select[multiple=multiple]:focus {
|
116
|
-
border-color: none;
|
117
|
-
box-shadow: none;
|
118
|
-
}
|
119
|
-
|
120
|
-
h2, h3, h4, h5 {
|
121
|
-
color: var(--MAIN-TITLES-TEXT-color) !important;
|
122
|
-
}
|
123
|
-
|
124
|
-
a {
|
125
|
-
color: var(--MAIN-LINK-color);
|
126
|
-
}
|
127
|
-
|
128
|
-
.anchor {
|
129
|
-
color: var(--MAIN-ANCHOR-color);
|
130
|
-
}
|
131
|
-
|
132
|
-
a:hover {
|
133
|
-
color: var(--MAIN-LINK-HOVER-color);
|
134
|
-
}
|
135
|
-
|
136
|
-
#sidebar ul li.visited > a .read-icon {
|
137
|
-
color: var(--MENU-VISITED-color);
|
138
|
-
}
|
139
|
-
|
140
|
-
#body a.highlight:after {
|
141
|
-
display: block;
|
142
|
-
content: "";
|
143
|
-
height: 1px;
|
144
|
-
width: 0%;
|
145
|
-
-webkit-transition: width 0.5s ease;
|
146
|
-
-moz-transition: width 0.5s ease;
|
147
|
-
-ms-transition: width 0.5s ease;
|
148
|
-
transition: width 0.5s ease;
|
149
|
-
background-color: var(--MAIN-LINK-HOVER-color);
|
150
|
-
}
|
151
|
-
#sidebar {
|
152
|
-
background-color: var(--MENU-SECTIONS-BG-color);
|
153
|
-
}
|
154
|
-
#sidebar #header-wrapper {
|
155
|
-
background: var(--MENU-HEADER-BG-color);
|
156
|
-
color: var(--MENU-SEARCH-BOX-color);
|
157
|
-
border-color: var(--MENU-HEADER-BORDER-color);
|
158
|
-
}
|
159
|
-
#sidebar .searchbox {
|
160
|
-
border-color: var(--MENU-SEARCH-BOX-color);
|
161
|
-
background: var(--MENU-SEARCH-BG-color);
|
162
|
-
}
|
163
|
-
#sidebar ul.topics > li.parent, #sidebar ul.topics > li.active {
|
164
|
-
background: var(--MENU-SECTIONS-ACTIVE-BG-color);
|
165
|
-
}
|
166
|
-
#sidebar .searchbox * {
|
167
|
-
color: var(--MENU-SEARCH-BOX-ICONS-color);
|
168
|
-
}
|
169
|
-
|
170
|
-
#sidebar a {
|
171
|
-
color: var(--MENU-SECTIONS-LINK-color);
|
172
|
-
}
|
173
|
-
|
174
|
-
#sidebar a:hover {
|
175
|
-
color: var(--MENU-SECTIONS-LINK-HOVER-color);
|
176
|
-
}
|
177
|
-
|
178
|
-
#sidebar ul li.active > a {
|
179
|
-
background: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color);
|
180
|
-
color: var(--MENU-SECTION-ACTIVE-CATEGORY-color) !important;
|
181
|
-
}
|
182
|
-
|
183
|
-
#sidebar hr {
|
184
|
-
border-color: var(--MENU-SECTION-HR-color);
|
185
|
-
}
|
186
|
-
```
|
187
|
-
|
188
|
-
Then, set the `themeVariant` value with the name of your custom theme file. That's it !
|
189
|
-
|
190
|
-
```toml
|
191
|
-
[params]
|
192
|
-
# Change default color scheme with a variant one. Can be "red", "blue", "green".
|
193
|
-
themeVariant = "mine"
|
194
|
-
```
|