rbcli 0.2.11 → 0.2.12
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rakeTasks +7 -0
- data/.rbenv-gemsets +1 -0
- data/CHANGELOG.md +22 -0
- data/Gemfile.lock +25 -24
- data/README.md +2 -2
- data/docs-src/archetypes/default.md +6 -0
- data/docs-src/config.toml +37 -0
- data/docs-src/{docs/index.md → content/_index.md} +4 -4
- data/docs-src/content/advanced/_index.md +11 -0
- data/docs-src/{docs → content}/advanced/automatic_updates.md +6 -2
- data/docs-src/{docs → content}/advanced/command_types.md +8 -4
- data/docs-src/{docs → content}/advanced/distributed_state_locking.md +6 -2
- data/docs-src/{docs → content}/advanced/hooks.md +6 -2
- data/docs-src/{docs → content}/advanced/interactive_commands.md +5 -1
- data/docs-src/{docs → content}/advanced/logging.md +6 -2
- data/docs-src/{docs → content}/advanced/remote_execution.md +5 -1
- data/docs-src/{docs → content}/advanced/state_storage.md +6 -3
- data/docs-src/{docs → content}/advanced/user_config_files.md +5 -1
- data/docs-src/content/development/_index.md +11 -0
- data/docs-src/{docs/imported → content/development}/changelog.md +58 -6
- data/docs-src/{docs → content}/development/code_of_conduct.md +8 -1
- data/docs-src/{docs → content}/development/contributing.md +16 -1
- data/docs-src/{docs → content}/development/license.md +9 -2
- data/docs-src/{docs/imported/quick_reference.md → content/quick_reference/_index.md} +8 -1
- data/docs-src/{docs → content}/tutorial/10-getting_started.md +7 -1
- data/docs-src/{docs → content}/tutorial/20-project_layout.md +10 -2
- data/docs-src/{docs → content}/tutorial/30-your_first_command.md +10 -4
- data/docs-src/{docs → content}/tutorial/40-options_parameters_and_arguments.md +9 -3
- data/docs-src/{docs → content}/tutorial/50-publishing.md +9 -3
- data/docs-src/content/tutorial/_index.md +11 -0
- data/docs-src/{docs/whoami.md → content/whoami/_index.md} +11 -5
- data/docs-src/layouts/partials/logo.html +3 -0
- data/docs-src/makesite.sh +33 -7
- data/docs-src/mkdocs-archived.tar.gz +0 -0
- data/docs-src/runsite.sh +6 -1
- data/docs-src/themes/hugo-theme-learn/.editorconfig +16 -0
- data/docs-src/themes/hugo-theme-learn/.gitignore +3 -0
- data/docs-src/themes/hugo-theme-learn/.grenrc.yml +25 -0
- data/docs-src/themes/hugo-theme-learn/CHANGELOG.md +154 -0
- data/docs-src/themes/hugo-theme-learn/LICENSE.md +22 -0
- data/docs-src/themes/hugo-theme-learn/README.md +60 -0
- data/docs-src/themes/hugo-theme-learn/archetypes/chapter.md +13 -0
- data/docs-src/themes/hugo-theme-learn/archetypes/default.md +7 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/LICENSE.md +20 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/config.toml +75 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/_index.en.md +41 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/_index.fr.md +43 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.en.md +12 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.fr.md +12 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.en.md +58 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.fr.md +54 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.en.md +102 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.fr.md +100 -0
- 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 +11 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.fr.md +11 -0
- 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 +194 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.fr.md +194 -0
- 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 +12 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/_index.fr.md +12 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.en.md +57 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.fr.md +57 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/_index.en.md +78 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/_index.fr.md +78 -0
- 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 +41 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.en.md +665 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.fr.md +666 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/menushortcuts.en.md +109 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/menushortcuts.fr.md +109 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.en.md +166 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.fr.md +146 -0
- 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/tags.en.md +39 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/tags.fr.md +40 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/credits.en.md +28 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/credits.fr.md +28 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/_index.en.md +16 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/_index.fr.md +16 -0
- 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 +85 -0
- 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 +85 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.en.md +16 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.fr.md +16 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.en.md +45 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.fr.md +45 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/_index.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/_index.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.fr.md +6 -0
- 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
- 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
- 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
- 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
- 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
- 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
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/_index.en.md +11 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/_index.fr.md +11 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/test3.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/test3.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-3/_index.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-3/_index.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-4/_index.en.md +7 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-4/_index.fr.md +7 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/test.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/test.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/expand.en.md +45 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/expand.fr.md +45 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/mermaid.en.md +283 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/mermaid.fr.md +283 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.en.md +62 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.fr.md +62 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/siteparam.en.md +23 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/siteparam.fr.md +23 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.en.md +10 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.fr.md +11 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/custom-footer.html +10 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/logo.html +39 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/menu-footer.html +14 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/shortcodes/ghcontributors.html +31 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/css/theme-mine.css +104 -0
- 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 +237 -0
- 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/tat.png +0 -0
- data/docs-src/themes/hugo-theme-learn/i18n/en.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/es.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/fr.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/id.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/nl.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/pt.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/tr.toml +26 -0
- 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 +56 -0
- data/docs-src/themes/hugo-theme-learn/layouts/_default/list.html +22 -0
- data/docs-src/themes/hugo-theme-learn/layouts/_default/single.html +13 -0
- data/docs-src/themes/hugo-theme-learn/layouts/index.html +31 -0
- data/docs-src/themes/hugo-theme-learn/layouts/index.json +12 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-comments.html +3 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-footer.html +5 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-header.html +5 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/favicon.html +1 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/footer.html +78 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/header.html +109 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/logo.html +19 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/menu-footer.html +1 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/menu.html +150 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/meta.html +2 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/search.html +16 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/tags.html +7 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/toc.html +5 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/attachments.html +36 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/button.html +14 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/children.html +101 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/expand.html +17 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/mermaid.html +2 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/notice.html +2 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/ref.html +14 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/relref.html +14 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/siteparam.html +7 -0
- data/docs-src/themes/hugo-theme-learn/netlify.toml +24 -0
- data/docs-src/themes/hugo-theme-learn/static/css/atom-one-dark-reasonable.css +77 -0
- data/docs-src/themes/hugo-theme-learn/static/css/auto-complete.css +47 -0
- data/docs-src/themes/hugo-theme-learn/static/css/featherlight.min.css +8 -0
- data/docs-src/themes/hugo-theme-learn/static/css/fontawesome-all.min.css +1 -0
- data/docs-src/themes/hugo-theme-learn/static/css/hugo-theme.css +254 -0
- data/docs-src/themes/hugo-theme-learn/static/css/hybrid.css +102 -0
- data/docs-src/themes/hugo-theme-learn/static/css/nucleus.css +615 -0
- data/docs-src/themes/hugo-theme-learn/static/css/perfect-scrollbar.min.css +2 -0
- data/docs-src/themes/hugo-theme-learn/static/css/tags.css +49 -0
- data/docs-src/themes/hugo-theme-learn/static/css/theme-blue.css +111 -0
- data/docs-src/themes/hugo-theme-learn/static/css/theme-green.css +111 -0
- data/docs-src/themes/hugo-theme-learn/static/css/theme-red.css +111 -0
- data/docs-src/themes/hugo-theme-learn/static/css/theme.css +1132 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.svg +359 -0
- 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 +1019 -0
- 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 +918 -0
- 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 +332 -0
- 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 +331 -0
- 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 +333 -0
- 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 +1 -0
- 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 +223 -0
- data/docs-src/themes/hugo-theme-learn/static/js/clipboard.min.js +7 -0
- data/docs-src/themes/hugo-theme-learn/static/js/featherlight.min.js +9 -0
- data/docs-src/themes/hugo-theme-learn/static/js/highlight.pack.js +3 -0
- data/docs-src/themes/hugo-theme-learn/static/js/html5shiv-printshiv.min.js +4 -0
- data/docs-src/themes/hugo-theme-learn/static/js/hugo-learn.js +91 -0
- data/docs-src/themes/hugo-theme-learn/static/js/jquery-3.3.1.min.js +2 -0
- data/docs-src/themes/hugo-theme-learn/static/js/jquery.sticky.js +288 -0
- data/docs-src/themes/hugo-theme-learn/static/js/learn.js +459 -0
- data/docs-src/themes/hugo-theme-learn/static/js/lunr.min.js +6 -0
- data/docs-src/themes/hugo-theme-learn/static/js/modernizr.custom-3.6.0.js +3 -0
- data/docs-src/themes/hugo-theme-learn/static/js/perfect-scrollbar.jquery.min.js +2 -0
- data/docs-src/themes/hugo-theme-learn/static/js/perfect-scrollbar.min.js +2 -0
- data/docs-src/themes/hugo-theme-learn/static/js/search.js +93 -0
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.css +277 -0
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.dark.css +278 -0
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.forest.css +356 -0
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.js +8 -0
- 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 +1260 -0
- 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 +471 -0
- 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 +2763 -0
- 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 +21 -0
- data/docs-src/themes/hugo-theme-learn/wercker.yml +16 -0
- data/docs/404.html +54 -670
- data/docs/advanced/automatic_updates/index.html +962 -635
- data/docs/advanced/command_types/index.html +1021 -736
- data/docs/advanced/distributed_state_locking/index.html +957 -622
- data/docs/advanced/hooks/index.html +968 -661
- data/docs/advanced/index.html +1099 -0
- data/docs/advanced/index.xml +117 -0
- data/docs/advanced/interactive_commands/index.html +960 -636
- data/docs/advanced/logging/index.html +963 -639
- data/docs/advanced/remote_execution/index.html +959 -634
- data/docs/advanced/state_storage/index.html +1049 -764
- data/docs/advanced/user_config_files/index.html +981 -649
- data/docs/categories/index.html +1094 -0
- data/docs/categories/index.xml +14 -0
- data/docs/css/atom-one-dark-reasonable.css +77 -0
- data/docs/css/auto-complete.css +47 -0
- data/docs/css/featherlight.min.css +8 -0
- data/docs/css/fontawesome-all.min.css +1 -0
- data/docs/css/hugo-theme.css +254 -0
- data/docs/css/hybrid.css +102 -0
- data/docs/css/nucleus.css +615 -0
- data/docs/css/perfect-scrollbar.min.css +2 -0
- data/docs/css/tags.css +49 -0
- data/docs/css/theme-blue.css +111 -0
- data/docs/css/theme-green.css +111 -0
- data/docs/css/theme-red.css +111 -0
- data/docs/css/theme.css +1132 -0
- data/docs/development/changelog/index.html +1368 -0
- data/docs/development/code_of_conduct/index.html +969 -687
- data/docs/development/contributing/index.html +993 -587
- data/docs/development/index.html +1099 -0
- data/docs/development/index.xml +54 -0
- data/docs/development/license/index.html +959 -579
- data/docs/fonts/Inconsolata.eot +0 -0
- data/docs/fonts/Inconsolata.svg +359 -0
- 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 +1019 -0
- 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 +918 -0
- 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 +332 -0
- 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 +331 -0
- 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 +333 -0
- 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 +1 -0
- data/docs/images/favicon.png +0 -0
- data/docs/images/gopher-404.jpg +0 -0
- data/docs/imported/changelog/index.html +1208 -1020
- data/docs/imported/index.html +1191 -0
- data/docs/imported/index.xml +23 -0
- data/docs/index.html +907 -591
- data/docs/index.json +183 -0
- data/docs/index.xml +212 -0
- data/docs/js/auto-complete.js +223 -0
- data/docs/js/clipboard.min.js +7 -0
- data/docs/js/featherlight.min.js +9 -0
- data/docs/js/highlight.pack.js +3 -0
- data/docs/js/html5shiv-printshiv.min.js +4 -0
- data/docs/js/hugo-learn.js +91 -0
- data/docs/js/jquery-3.3.1.min.js +2 -0
- data/docs/js/jquery.sticky.js +288 -0
- data/docs/js/learn.js +459 -0
- data/docs/js/lunr.min.js +6 -0
- data/docs/js/modernizr.custom-3.6.0.js +3 -0
- data/docs/js/perfect-scrollbar.jquery.min.js +2 -0
- data/docs/js/perfect-scrollbar.min.js +2 -0
- data/docs/js/search.js +93 -0
- data/docs/mermaid/mermaid.css +277 -0
- data/docs/mermaid/mermaid.dark.css +278 -0
- data/docs/mermaid/mermaid.forest.css +356 -0
- data/docs/mermaid/mermaid.js +8 -0
- data/docs/quick_reference/index.html +1279 -0
- data/docs/quick_reference/index.xml +15 -0
- data/docs/sitemap.xml +135 -107
- data/docs/tags/index.html +1094 -0
- data/docs/tags/index.xml +14 -0
- data/docs/tutorial/10-getting_started/index.html +960 -649
- data/docs/tutorial/20-project_layout/index.html +1059 -778
- data/docs/tutorial/30-your_first_command/index.html +1040 -729
- data/docs/tutorial/40-options_parameters_and_arguments/index.html +1151 -868
- data/docs/tutorial/50-publishing/index.html +969 -676
- data/docs/tutorial/index.html +1099 -0
- data/docs/tutorial/index.xml +71 -0
- data/docs/webfonts/fa-brands-400.eot +0 -0
- data/docs/webfonts/fa-brands-400.svg +1260 -0
- 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 +471 -0
- 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 +2763 -0
- 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 +947 -567
- data/docs/whoami/index.xml +15 -0
- data/exe/rbcli +1 -0
- data/lib/rbcli-tool/project.rb +6 -2
- data/lib/rbcli/version.rb +1 -1
- data/rbcli.gemspec +1 -1
- data/skeletons/project/.rakeTasks +7 -0
- data/skeletons/project/exe/executable +1 -3
- data/skeletons/project/lib/lib.erb +7 -0
- data/skeletons/project/untitled.gemspec +13 -15
- metadata +356 -65
- data/docs-src/mkdocs.yml +0 -79
- data/docs/assets/fonts/font-awesome.css +0 -4
- data/docs/assets/fonts/material-icons.css +0 -13
- data/docs/assets/fonts/specimen/FontAwesome.ttf +0 -0
- data/docs/assets/fonts/specimen/FontAwesome.woff +0 -0
- data/docs/assets/fonts/specimen/FontAwesome.woff2 +0 -0
- data/docs/assets/fonts/specimen/MaterialIcons-Regular.ttf +0 -0
- data/docs/assets/fonts/specimen/MaterialIcons-Regular.woff +0 -0
- data/docs/assets/fonts/specimen/MaterialIcons-Regular.woff2 +0 -0
- data/docs/assets/images/favicon.png +0 -0
- data/docs/assets/images/icons/bitbucket.1b09e088.svg +0 -20
- data/docs/assets/images/icons/github.f0b8504a.svg +0 -18
- data/docs/assets/images/icons/gitlab.6dd19c00.svg +0 -38
- data/docs/assets/javascripts/application.583bbe55.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.da.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.de.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.du.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.es.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.fi.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.fr.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.hu.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.it.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.jp.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.multi.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.no.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.pt.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.ro.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.ru.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.stemmer.support.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.sv.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.tr.js +0 -1
- data/docs/assets/javascripts/lunr/tinyseg.js +0 -1
- data/docs/assets/javascripts/modernizr.1aa3b519.js +0 -1
- data/docs/assets/stylesheets/application-palette.22915126.css +0 -1176
- data/docs/assets/stylesheets/application.451f80e5.css +0 -2552
- data/docs/imported/quick_reference/index.html +0 -1120
- data/docs/search/search_index.json +0 -1
- data/docs/sitemap.xml.gz +0 -0
- data/skeletons/project/lib/.keep +0 -0
Binary file
|
Binary file
|
Binary file
|
@@ -0,0 +1,57 @@
|
|
1
|
+
---
|
2
|
+
title: Archetypes
|
3
|
+
weight: 10
|
4
|
+
---
|
5
|
+
|
6
|
+
Using the command: `hugo new [relative new content path]`, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more : [archetypes](https://gohugo.io/content/archetypes/).
|
7
|
+
|
8
|
+
It is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences.
|
9
|
+
|
10
|
+
## Chapter {#archetypes-chapter}
|
11
|
+
|
12
|
+
To create a Chapter page, run the following commands
|
13
|
+
|
14
|
+
```
|
15
|
+
hugo new --kind chapter <name>/_index.md
|
16
|
+
```
|
17
|
+
|
18
|
+
It will create a page with predefined Front-Matter:
|
19
|
+
|
20
|
+
```markdown
|
21
|
+
+++
|
22
|
+
title = "{{ replace .Name "-" " " | title }}"
|
23
|
+
date = {{ .Date }}
|
24
|
+
weight = 5
|
25
|
+
chapter = true
|
26
|
+
pre = "<b>X. </b>"
|
27
|
+
+++
|
28
|
+
|
29
|
+
### Chapter X
|
30
|
+
|
31
|
+
# Some Chapter title
|
32
|
+
|
33
|
+
Lorem Ipsum.
|
34
|
+
```
|
35
|
+
|
36
|
+
## Default
|
37
|
+
|
38
|
+
To create a default page, run either one of the following commands
|
39
|
+
|
40
|
+
```
|
41
|
+
# Either
|
42
|
+
hugo new <chapter>/<name>/_index.md
|
43
|
+
# Or
|
44
|
+
hugo new <chapter>/<name>.md
|
45
|
+
```
|
46
|
+
|
47
|
+
It will create a page with predefined Front-Matter:
|
48
|
+
|
49
|
+
```markdown
|
50
|
+
+++
|
51
|
+
title = "{{ replace .Name "-" " " | title }}"
|
52
|
+
date = {{ .Date }}
|
53
|
+
weight = 5
|
54
|
+
+++
|
55
|
+
|
56
|
+
Lorem Ipsum.
|
57
|
+
```
|
@@ -0,0 +1,57 @@
|
|
1
|
+
---
|
2
|
+
title: Archétypes
|
3
|
+
weight: 10
|
4
|
+
---
|
5
|
+
|
6
|
+
En utilisant la commande: `hugo new [chemin vers nouveau contenu]`, vous pouvez créer un nouveau fichier avec la date et le title automatiquement initialisé. Même si c'est une fonctionnalité intéressante, elle reste limitée pour les auteurs actifs qui ont besoin de mieux : les [archetypes](https://gohugo.io/content/archetypes/).
|
7
|
+
|
8
|
+
Les archétypes sont des squelettes de pages préconfigurées avec un Front Matter par défaut. Merci de vous référer à la documentation pour connaitre les différents types de page.
|
9
|
+
|
10
|
+
## Chapitre {#archetypes-chapter}
|
11
|
+
|
12
|
+
Pour créer un chapitre, lancez les commandes suivantes
|
13
|
+
|
14
|
+
```
|
15
|
+
hugo new --kind chapter <name>/_index.md
|
16
|
+
```
|
17
|
+
|
18
|
+
Cela crééra une page avec le Front Matter suivant:
|
19
|
+
|
20
|
+
```markdown
|
21
|
+
+++
|
22
|
+
title = "{{ replace .Name "-" " " | title }}"
|
23
|
+
date = {{ .Date }}
|
24
|
+
weight = 5
|
25
|
+
chapter = true
|
26
|
+
pre = "<b>X. </b>"
|
27
|
+
+++
|
28
|
+
|
29
|
+
### Chapter X
|
30
|
+
|
31
|
+
# Some Chapter title
|
32
|
+
|
33
|
+
Lorem Ipsum.
|
34
|
+
```
|
35
|
+
|
36
|
+
## Défaut
|
37
|
+
|
38
|
+
Pour créer une page classique, lancer l'une des deux commandes suivantes
|
39
|
+
|
40
|
+
```
|
41
|
+
# Soit
|
42
|
+
hugo new <chapter>/<name>/_index.md
|
43
|
+
# Ou
|
44
|
+
hugo new <chapter>/<name>.md
|
45
|
+
```
|
46
|
+
|
47
|
+
Cela crééra une page avec le Front Matter suivant:
|
48
|
+
|
49
|
+
```markdown
|
50
|
+
+++
|
51
|
+
title = "{{ replace .Name "-" " " | title }}"
|
52
|
+
date = {{ .Date }}
|
53
|
+
weight = 5
|
54
|
+
+++
|
55
|
+
|
56
|
+
Lorem Ipsum.
|
57
|
+
```
|
@@ -0,0 +1,78 @@
|
|
1
|
+
---
|
2
|
+
date: 2016-04-09T16:50:16+02:00
|
3
|
+
title: Multilingual and i18n
|
4
|
+
weight: 30
|
5
|
+
---
|
6
|
+
|
7
|
+
**Learn theme** is fully compatible with Hugo multilingual mode.
|
8
|
+
|
9
|
+
It provides:
|
10
|
+
|
11
|
+
- Translation strings for default values (English and French). Feel free to contribute !
|
12
|
+
- Automatic menu generation from multilingual content
|
13
|
+
- In-browser language switching
|
14
|
+
|
15
|
+
![I18n menu](/en/cont/i18n/images/i18n-menu.gif)
|
16
|
+
|
17
|
+
## Basic configuration
|
18
|
+
|
19
|
+
After learning [how Hugo handle multilingual websites](https://gohugo.io/content-management/multilingual), define your languages in your `config.toml` file.
|
20
|
+
|
21
|
+
For example with current French and English website.
|
22
|
+
|
23
|
+
```toml
|
24
|
+
# English is the default language
|
25
|
+
defaultContentLanguage = "en"
|
26
|
+
# Force to have /en/my-page and /fr/my-page routes, even for default language.
|
27
|
+
defaultContentLanguageInSubdir= true
|
28
|
+
|
29
|
+
[Languages]
|
30
|
+
[Languages.en]
|
31
|
+
title = "Documentation for Hugo Learn Theme"
|
32
|
+
weight = 1
|
33
|
+
languageName = "English"
|
34
|
+
|
35
|
+
[Languages.fr]
|
36
|
+
title = "Documentation du thème Hugo Learn"
|
37
|
+
weight = 2
|
38
|
+
languageName = "Français"
|
39
|
+
```
|
40
|
+
|
41
|
+
Then, for each new page, append the *id* of the language to the file.
|
42
|
+
|
43
|
+
- Single file `my-page.md` is split in two files:
|
44
|
+
- in English: `my-page.en.md`
|
45
|
+
- in French: `my-page.fr.md`
|
46
|
+
- Single file `_index.md` is split in two files:
|
47
|
+
- in English: `_index.en.md`
|
48
|
+
- in French: `_index.fr.md`
|
49
|
+
|
50
|
+
{{% notice info %}}
|
51
|
+
Be aware that only translated pages are displayed in menu. It's not replaced with default language content.
|
52
|
+
{{% /notice %}}
|
53
|
+
|
54
|
+
{{% notice tip %}}
|
55
|
+
Use [slug](https://gohugo.io/content-management/multilingual/#translate-your-content) Front Matter parameter to translate urls too.
|
56
|
+
{{% /notice %}}
|
57
|
+
|
58
|
+
## Overwrite translation strings
|
59
|
+
|
60
|
+
Translations strings are used for common default values used in the theme (*Edit this page* button, *Search placeholder* and so on). Translations are available in french and english but you may use another language or want to override default values.
|
61
|
+
|
62
|
+
To override these values, create a new file in your local i18n folder `i18n/<idlanguage>.toml` and inspire yourself from the theme `themes/hugo-theme-learn/i18n/en.toml`
|
63
|
+
|
64
|
+
By the way, as these translations could be used by other people, please take the time to propose a translation by [making a PR](https://github.com/matcornic/hugo-theme-learn/pulls) to the theme !
|
65
|
+
|
66
|
+
## Disable language switching
|
67
|
+
|
68
|
+
Switching the language in the browser is a great feature, but for some reasons you may want to disable it.
|
69
|
+
|
70
|
+
Just set `disableLanguageSwitchingButton=true` in your `config.toml`
|
71
|
+
|
72
|
+
```toml
|
73
|
+
[params]
|
74
|
+
# When using mulitlingual website, disable the switch language button.
|
75
|
+
disableLanguageSwitchingButton = true
|
76
|
+
```
|
77
|
+
|
78
|
+
![I18n menu](/en/cont/i18n/images/i18n-menu.gif)
|
@@ -0,0 +1,78 @@
|
|
1
|
+
---
|
2
|
+
date: 2016-04-09T16:50:16+02:00
|
3
|
+
title: Multi-langue et i18n
|
4
|
+
weight: 30
|
5
|
+
---
|
6
|
+
|
7
|
+
**Learn** est complètement compatible avec le mode multi-langue d'Hugo.
|
8
|
+
|
9
|
+
Il fournit :
|
10
|
+
|
11
|
+
- Des *translation strings* pour les valeurs par défaut utilisées par le thème (Anglais et Français). N'hésitez pas à contribuer !
|
12
|
+
- Génération automatique du menu avec le contenu multi-langue
|
13
|
+
- Modification de la langue dans le navigateur
|
14
|
+
|
15
|
+
![I18n menu](/en/cont/i18n/images/i18n-menu.gif)
|
16
|
+
|
17
|
+
## Configuration simple
|
18
|
+
|
19
|
+
Après avoir appris [comment Hugo gère les sites multi-langue](https://gohugo.io/content-management/multilingual), définissez vos langues dans votre fichier `config.toml`.
|
20
|
+
|
21
|
+
Par exemple, pour ce site, avec du contenu en français et en anglais.
|
22
|
+
|
23
|
+
```toml
|
24
|
+
# Anglais est la langue par défaut
|
25
|
+
defaultContentLanguage = "en"
|
26
|
+
# Force d'avoir /en/ma-page et /fr/ma-page routes, même avec la langue par défaut.
|
27
|
+
defaultContentLanguageInSubdir= true
|
28
|
+
|
29
|
+
[Languages]
|
30
|
+
[Languages.en]
|
31
|
+
title = "Documentation for Hugo Learn Theme"
|
32
|
+
weight = 1
|
33
|
+
languageName = "English"
|
34
|
+
|
35
|
+
[Languages.fr]
|
36
|
+
title = "Documentation du thème Hugo Learn"
|
37
|
+
weight = 2
|
38
|
+
languageName = "Français"
|
39
|
+
```
|
40
|
+
|
41
|
+
Puis, pour chaque nouvelle page, ajoutez *l'id* de la langue du fichier.
|
42
|
+
|
43
|
+
- Le fichier `my-page.md` est découpé en deux fichiers :
|
44
|
+
- en anglais : `my-page.en.md`
|
45
|
+
- en français : `my-page.fr.md`
|
46
|
+
- Le fichier `_index.md` est découpé en deux fichiers :
|
47
|
+
- en anglais: `_index.en.md`
|
48
|
+
- en français: `_index.fr.md`
|
49
|
+
|
50
|
+
{{% notice info %}}
|
51
|
+
Attention, seulement les pages traduites sont affichées dans le menu. Le contenu n'est pas remplacé par les pages de la langue par défaut.
|
52
|
+
{{% /notice %}}
|
53
|
+
|
54
|
+
{{% notice tip %}}
|
55
|
+
Utilisez le paramètre du Front Matter [slug](https://gohugo.io/content-management/multilingual/#translate-your-content) pour traduire également les URLs.
|
56
|
+
{{% /notice %}}
|
57
|
+
|
58
|
+
## Surcharger les *translation strings*
|
59
|
+
|
60
|
+
Les *Translations strings* sont utilisées comme valeurs par défaut dans le thème (Bouton *Modifier la page*, Element de subsitution *Recherche*, etc.). Les traductions sont disponibles en français et en anglais mais vous pouvez utiliser n'importe quelle autre langue et surcharger avec vos propres valeurs.
|
61
|
+
|
62
|
+
Pour surcharger ces valeurs, créer un nouveau fichier dans votre dossier i18n local `i18n/<idlanguage>.toml` et inspirez vous du thème `themes/hugo-theme-learn/i18n/en.toml`
|
63
|
+
|
64
|
+
D'ailleurs, ces traductions pour servir à tout le monde, donc svp prenez le temps de [proposer une Pull Request](https://github.com/matcornic/hugo-theme-learn/pulls) !
|
65
|
+
|
66
|
+
## Désactiver le changement de langue
|
67
|
+
|
68
|
+
Vous pouvez changer de langue directement dans le navigateur. C'est une super fonctionnalité, mais vous avez peut-être besoin de la désactiver.
|
69
|
+
|
70
|
+
Pour ce faire, ajouter le paramètre `disableLanguageSwitchingButton=true` dans votre `config.toml`
|
71
|
+
|
72
|
+
```toml
|
73
|
+
[params]
|
74
|
+
# Quand vous utilisez un site en multi-langue, désactive le bouton de changment de langue.
|
75
|
+
disableLanguageSwitchingButton = true
|
76
|
+
```
|
77
|
+
|
78
|
+
![I18n menu](/en/cont/i18n/images/i18n-menu.gif)
|
Binary file
|
@@ -0,0 +1,41 @@
|
|
1
|
+
---
|
2
|
+
title: Icons and logos
|
3
|
+
weight: 27
|
4
|
+
---
|
5
|
+
|
6
|
+
The Learn theme for Hugo loads the [**Font Awesome**](https://fontawesome.com) library, allowing you to easily display any icon or logo available in the Font Awesome free collection.
|
7
|
+
|
8
|
+
## Finding an icon
|
9
|
+
|
10
|
+
Browse through the available icons in the [Font Awesome Gallery](https://fontawesome.com/icons?d=gallery&m=free). Notice that the **free** filter is enabled, as only the free icons are available by default.
|
11
|
+
|
12
|
+
Once on the Font Awesome page for a specific icon, for example the page for the [heart](https://fontawesome.com/icons/heart?style=solid), copy the HTML reference and paste into the markdown content.
|
13
|
+
|
14
|
+
The HTML to include the heart icon is:
|
15
|
+
|
16
|
+
```
|
17
|
+
<i class="fas fa-heart"></i>
|
18
|
+
```
|
19
|
+
|
20
|
+
## Including in markdown
|
21
|
+
|
22
|
+
Paste the `<i>` HTML into markup and Font Awesome will load the relevant icon.
|
23
|
+
|
24
|
+
```
|
25
|
+
Built with <i class="fas fa-heart"></i> from Grav and Hugo
|
26
|
+
```
|
27
|
+
|
28
|
+
Which appears as
|
29
|
+
|
30
|
+
Built with <i class="fas fa-heart"></i> from Grav and Hugo
|
31
|
+
|
32
|
+
## Customising icons
|
33
|
+
|
34
|
+
Font Awesome provides many ways to modify the icon
|
35
|
+
|
36
|
+
* Change colour (by default the icon will inherit the parent colour)
|
37
|
+
* Increase or decrease size
|
38
|
+
* Rotate
|
39
|
+
* Combine with other icons
|
40
|
+
|
41
|
+
Check the full documentation on [web fonts with CSS](https://fontawesome.com/how-to-use/web-fonts-with-css) for more.
|
@@ -0,0 +1,665 @@
|
|
1
|
+
---
|
2
|
+
date: 2016-04-09T16:50:16+02:00
|
3
|
+
title: Markdown syntax
|
4
|
+
weight: 15
|
5
|
+
---
|
6
|
+
|
7
|
+
{{% notice note %}}
|
8
|
+
This page is a shameful copy of the great [Grav original page](http://learn.getgrav.org/content/markdown).
|
9
|
+
Only difference is information about image customization ([resizing]({{< relref "#resizing-image" >}}), [add CSS classes]({{< relref "#add-css-classes" >}})...)
|
10
|
+
{{% /notice%}}
|
11
|
+
|
12
|
+
Let's face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.
|
13
|
+
|
14
|
+
**Markdown** is a better way to write **HTML**, without all the complexities and ugliness that usually accompanies it.
|
15
|
+
|
16
|
+
Some of the key benefits are:
|
17
|
+
|
18
|
+
1. Markdown is simple to learn, with minimal extra characters so it's also quicker to write content.
|
19
|
+
2. Less chance of errors when writing in markdown.
|
20
|
+
3. Produces valid XHTML output.
|
21
|
+
4. Keeps the content and the visual display separate, so you cannot mess up the look of your site.
|
22
|
+
5. Write in any text editor or Markdown application you like.
|
23
|
+
6. Markdown is a joy to use!
|
24
|
+
|
25
|
+
John Gruber, the author of Markdown, puts it like this:
|
26
|
+
|
27
|
+
> The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
|
28
|
+
> -- <cite>John Gruber</cite>
|
29
|
+
|
30
|
+
|
31
|
+
Grav ships with built-in support for [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). You must enable **Markdown Extra** in your `system.yaml` configuration file
|
32
|
+
|
33
|
+
Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:
|
34
|
+
|
35
|
+
{{% notice info %}}
|
36
|
+
<i class="fas fa-bookmark"></i> Bookmark this page for easy future reference!
|
37
|
+
{{% /notice %}}
|
38
|
+
|
39
|
+
## Headings
|
40
|
+
|
41
|
+
Headings from `h1` through `h6` are constructed with a `#` for each level:
|
42
|
+
|
43
|
+
```markdown
|
44
|
+
# h1 Heading
|
45
|
+
## h2 Heading
|
46
|
+
### h3 Heading
|
47
|
+
#### h4 Heading
|
48
|
+
##### h5 Heading
|
49
|
+
###### h6 Heading
|
50
|
+
```
|
51
|
+
|
52
|
+
Renders to:
|
53
|
+
|
54
|
+
# h1 Heading
|
55
|
+
## h2 Heading
|
56
|
+
### h3 Heading
|
57
|
+
#### h4 Heading
|
58
|
+
##### h5 Heading
|
59
|
+
###### h6 Heading
|
60
|
+
|
61
|
+
HTML:
|
62
|
+
|
63
|
+
```html
|
64
|
+
<h1>h1 Heading</h1>
|
65
|
+
<h2>h2 Heading</h2>
|
66
|
+
<h3>h3 Heading</h3>
|
67
|
+
<h4>h4 Heading</h4>
|
68
|
+
<h5>h5 Heading</h5>
|
69
|
+
<h6>h6 Heading</h6>
|
70
|
+
```
|
71
|
+
|
72
|
+
## Comments
|
73
|
+
|
74
|
+
Comments should be HTML compatible
|
75
|
+
|
76
|
+
```html
|
77
|
+
<!--
|
78
|
+
This is a comment
|
79
|
+
-->
|
80
|
+
```
|
81
|
+
Comment below should **NOT** be seen:
|
82
|
+
|
83
|
+
<!--
|
84
|
+
This is a comment
|
85
|
+
-->
|
86
|
+
|
87
|
+
|
88
|
+
## Horizontal Rules
|
89
|
+
|
90
|
+
The HTML `<hr>` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `<hr>` with any of the following:
|
91
|
+
|
92
|
+
* `___`: three consecutive underscores
|
93
|
+
* `---`: three consecutive dashes
|
94
|
+
* `***`: three consecutive asterisks
|
95
|
+
|
96
|
+
renders to:
|
97
|
+
|
98
|
+
___
|
99
|
+
|
100
|
+
---
|
101
|
+
|
102
|
+
***
|
103
|
+
|
104
|
+
|
105
|
+
## Body Copy
|
106
|
+
|
107
|
+
Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML.
|
108
|
+
|
109
|
+
So this body copy:
|
110
|
+
|
111
|
+
```markdown
|
112
|
+
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
113
|
+
```
|
114
|
+
renders to this HTML:
|
115
|
+
|
116
|
+
```html
|
117
|
+
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
|
118
|
+
```
|
119
|
+
|
120
|
+
## Emphasis
|
121
|
+
|
122
|
+
### Bold
|
123
|
+
For emphasizing a snippet of text with a heavier font-weight.
|
124
|
+
|
125
|
+
The following snippet of text is **rendered as bold text**.
|
126
|
+
|
127
|
+
```markdown
|
128
|
+
**rendered as bold text**
|
129
|
+
```
|
130
|
+
renders to:
|
131
|
+
|
132
|
+
**rendered as bold text**
|
133
|
+
|
134
|
+
and this HTML
|
135
|
+
|
136
|
+
```html
|
137
|
+
<strong>rendered as bold text</strong>
|
138
|
+
```
|
139
|
+
|
140
|
+
### Italics
|
141
|
+
For emphasizing a snippet of text with italics.
|
142
|
+
|
143
|
+
The following snippet of text is _rendered as italicized text_.
|
144
|
+
|
145
|
+
```markdown
|
146
|
+
_rendered as italicized text_
|
147
|
+
```
|
148
|
+
|
149
|
+
renders to:
|
150
|
+
|
151
|
+
_rendered as italicized text_
|
152
|
+
|
153
|
+
and this HTML:
|
154
|
+
|
155
|
+
```html
|
156
|
+
<em>rendered as italicized text</em>
|
157
|
+
```
|
158
|
+
|
159
|
+
|
160
|
+
### strikethrough
|
161
|
+
In GFM (GitHub flavored Markdown) you can do strikethroughs.
|
162
|
+
|
163
|
+
```markdown
|
164
|
+
~~Strike through this text.~~
|
165
|
+
```
|
166
|
+
Which renders to:
|
167
|
+
|
168
|
+
~~Strike through this text.~~
|
169
|
+
|
170
|
+
HTML:
|
171
|
+
|
172
|
+
```html
|
173
|
+
<del>Strike through this text.</del>
|
174
|
+
```
|
175
|
+
|
176
|
+
## Blockquotes
|
177
|
+
|
178
|
+
For quoting blocks of content from another source within your document.
|
179
|
+
|
180
|
+
Add `>` before any text you want to quote.
|
181
|
+
|
182
|
+
```markdown
|
183
|
+
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
|
184
|
+
```
|
185
|
+
|
186
|
+
Renders to:
|
187
|
+
|
188
|
+
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
|
189
|
+
|
190
|
+
and this HTML:
|
191
|
+
|
192
|
+
```html
|
193
|
+
<blockquote>
|
194
|
+
<p><strong>Fusion Drive</strong> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.</p>
|
195
|
+
</blockquote>
|
196
|
+
```
|
197
|
+
|
198
|
+
Blockquotes can also be nested:
|
199
|
+
|
200
|
+
```markdown
|
201
|
+
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
202
|
+
>
|
203
|
+
> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
204
|
+
>
|
205
|
+
> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
|
206
|
+
```
|
207
|
+
|
208
|
+
Renders to:
|
209
|
+
|
210
|
+
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
211
|
+
>
|
212
|
+
> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
213
|
+
>
|
214
|
+
> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
|
215
|
+
|
216
|
+
## Notices
|
217
|
+
|
218
|
+
{{% notice note %}}
|
219
|
+
The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices)
|
220
|
+
{{% /notice %}}
|
221
|
+
|
222
|
+
|
223
|
+
## Lists
|
224
|
+
|
225
|
+
### Unordered
|
226
|
+
A list of items in which the order of the items does not explicitly matter.
|
227
|
+
|
228
|
+
You may use any of the following symbols to denote bullets for each list item:
|
229
|
+
|
230
|
+
```markdown
|
231
|
+
* valid bullet
|
232
|
+
- valid bullet
|
233
|
+
+ valid bullet
|
234
|
+
```
|
235
|
+
|
236
|
+
For example
|
237
|
+
|
238
|
+
```markdown
|
239
|
+
+ Lorem ipsum dolor sit amet
|
240
|
+
+ Consectetur adipiscing elit
|
241
|
+
+ Integer molestie lorem at massa
|
242
|
+
+ Facilisis in pretium nisl aliquet
|
243
|
+
+ Nulla volutpat aliquam velit
|
244
|
+
- Phasellus iaculis neque
|
245
|
+
- Purus sodales ultricies
|
246
|
+
- Vestibulum laoreet porttitor sem
|
247
|
+
- Ac tristique libero volutpat at
|
248
|
+
+ Faucibus porta lacus fringilla vel
|
249
|
+
+ Aenean sit amet erat nunc
|
250
|
+
+ Eget porttitor lorem
|
251
|
+
```
|
252
|
+
Renders to:
|
253
|
+
|
254
|
+
+ Lorem ipsum dolor sit amet
|
255
|
+
+ Consectetur adipiscing elit
|
256
|
+
+ Integer molestie lorem at massa
|
257
|
+
+ Facilisis in pretium nisl aliquet
|
258
|
+
+ Nulla volutpat aliquam velit
|
259
|
+
- Phasellus iaculis neque
|
260
|
+
- Purus sodales ultricies
|
261
|
+
- Vestibulum laoreet porttitor sem
|
262
|
+
- Ac tristique libero volutpat at
|
263
|
+
+ Faucibus porta lacus fringilla vel
|
264
|
+
+ Aenean sit amet erat nunc
|
265
|
+
+ Eget porttitor lorem
|
266
|
+
|
267
|
+
And this HTML
|
268
|
+
|
269
|
+
```html
|
270
|
+
<ul>
|
271
|
+
<li>Lorem ipsum dolor sit amet</li>
|
272
|
+
<li>Consectetur adipiscing elit</li>
|
273
|
+
<li>Integer molestie lorem at massa</li>
|
274
|
+
<li>Facilisis in pretium nisl aliquet</li>
|
275
|
+
<li>Nulla volutpat aliquam velit
|
276
|
+
<ul>
|
277
|
+
<li>Phasellus iaculis neque</li>
|
278
|
+
<li>Purus sodales ultricies</li>
|
279
|
+
<li>Vestibulum laoreet porttitor sem</li>
|
280
|
+
<li>Ac tristique libero volutpat at</li>
|
281
|
+
</ul>
|
282
|
+
</li>
|
283
|
+
<li>Faucibus porta lacus fringilla vel</li>
|
284
|
+
<li>Aenean sit amet erat nunc</li>
|
285
|
+
<li>Eget porttitor lorem</li>
|
286
|
+
</ul>
|
287
|
+
```
|
288
|
+
|
289
|
+
### Ordered
|
290
|
+
|
291
|
+
A list of items in which the order of items does explicitly matter.
|
292
|
+
|
293
|
+
```markdown
|
294
|
+
1. Lorem ipsum dolor sit amet
|
295
|
+
2. Consectetur adipiscing elit
|
296
|
+
3. Integer molestie lorem at massa
|
297
|
+
4. Facilisis in pretium nisl aliquet
|
298
|
+
5. Nulla volutpat aliquam velit
|
299
|
+
6. Faucibus porta lacus fringilla vel
|
300
|
+
7. Aenean sit amet erat nunc
|
301
|
+
8. Eget porttitor lorem
|
302
|
+
```
|
303
|
+
Renders to:
|
304
|
+
|
305
|
+
1. Lorem ipsum dolor sit amet
|
306
|
+
2. Consectetur adipiscing elit
|
307
|
+
3. Integer molestie lorem at massa
|
308
|
+
4. Facilisis in pretium nisl aliquet
|
309
|
+
5. Nulla volutpat aliquam velit
|
310
|
+
6. Faucibus porta lacus fringilla vel
|
311
|
+
7. Aenean sit amet erat nunc
|
312
|
+
8. Eget porttitor lorem
|
313
|
+
|
314
|
+
And this HTML:
|
315
|
+
|
316
|
+
```html
|
317
|
+
<ol>
|
318
|
+
<li>Lorem ipsum dolor sit amet</li>
|
319
|
+
<li>Consectetur adipiscing elit</li>
|
320
|
+
<li>Integer molestie lorem at massa</li>
|
321
|
+
<li>Facilisis in pretium nisl aliquet</li>
|
322
|
+
<li>Nulla volutpat aliquam velit</li>
|
323
|
+
<li>Faucibus porta lacus fringilla vel</li>
|
324
|
+
<li>Aenean sit amet erat nunc</li>
|
325
|
+
<li>Eget porttitor lorem</li>
|
326
|
+
</ol>
|
327
|
+
```
|
328
|
+
|
329
|
+
**TIP**: If you just use `1.` for each number, Markdown will automatically number each item. For example:
|
330
|
+
|
331
|
+
```markdown
|
332
|
+
1. Lorem ipsum dolor sit amet
|
333
|
+
1. Consectetur adipiscing elit
|
334
|
+
1. Integer molestie lorem at massa
|
335
|
+
1. Facilisis in pretium nisl aliquet
|
336
|
+
1. Nulla volutpat aliquam velit
|
337
|
+
1. Faucibus porta lacus fringilla vel
|
338
|
+
1. Aenean sit amet erat nunc
|
339
|
+
1. Eget porttitor lorem
|
340
|
+
```
|
341
|
+
|
342
|
+
Renders to:
|
343
|
+
|
344
|
+
1. Lorem ipsum dolor sit amet
|
345
|
+
2. Consectetur adipiscing elit
|
346
|
+
3. Integer molestie lorem at massa
|
347
|
+
4. Facilisis in pretium nisl aliquet
|
348
|
+
5. Nulla volutpat aliquam velit
|
349
|
+
6. Faucibus porta lacus fringilla vel
|
350
|
+
7. Aenean sit amet erat nunc
|
351
|
+
8. Eget porttitor lorem
|
352
|
+
|
353
|
+
## Code
|
354
|
+
|
355
|
+
### Inline code
|
356
|
+
Wrap inline snippets of code with `` ` ``.
|
357
|
+
|
358
|
+
```markdown
|
359
|
+
In this example, `<section></section>` should be wrapped as **code**.
|
360
|
+
```
|
361
|
+
|
362
|
+
Renders to:
|
363
|
+
|
364
|
+
In this example, `<section></section>` should be wrapped with **code**.
|
365
|
+
|
366
|
+
HTML:
|
367
|
+
|
368
|
+
```html
|
369
|
+
<p>In this example, <code><section></section></code> should be wrapped with <strong>code</strong>.</p>
|
370
|
+
```
|
371
|
+
|
372
|
+
### Indented code
|
373
|
+
|
374
|
+
Or indent several lines of code by at least four spaces, as in:
|
375
|
+
|
376
|
+
<pre>
|
377
|
+
// Some comments
|
378
|
+
line 1 of code
|
379
|
+
line 2 of code
|
380
|
+
line 3 of code
|
381
|
+
</pre>
|
382
|
+
|
383
|
+
Renders to:
|
384
|
+
|
385
|
+
// Some comments
|
386
|
+
line 1 of code
|
387
|
+
line 2 of code
|
388
|
+
line 3 of code
|
389
|
+
|
390
|
+
HTML:
|
391
|
+
|
392
|
+
```html
|
393
|
+
<pre>
|
394
|
+
<code>
|
395
|
+
// Some comments
|
396
|
+
line 1 of code
|
397
|
+
line 2 of code
|
398
|
+
line 3 of code
|
399
|
+
</code>
|
400
|
+
</pre>
|
401
|
+
```
|
402
|
+
|
403
|
+
|
404
|
+
### Block code "fences"
|
405
|
+
|
406
|
+
Use "fences" ```` ``` ```` to block in multiple lines of code.
|
407
|
+
|
408
|
+
<pre>
|
409
|
+
``` markup
|
410
|
+
Sample text here...
|
411
|
+
```
|
412
|
+
</pre>
|
413
|
+
|
414
|
+
|
415
|
+
```
|
416
|
+
Sample text here...
|
417
|
+
```
|
418
|
+
|
419
|
+
HTML:
|
420
|
+
|
421
|
+
```html
|
422
|
+
<pre>
|
423
|
+
<code>Sample text here...</code>
|
424
|
+
</pre>
|
425
|
+
```
|
426
|
+
|
427
|
+
### Syntax highlighting
|
428
|
+
|
429
|
+
GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
|
430
|
+
|
431
|
+
<pre>
|
432
|
+
```js
|
433
|
+
grunt.initConfig({
|
434
|
+
assemble: {
|
435
|
+
options: {
|
436
|
+
assets: 'docs/assets',
|
437
|
+
data: 'src/data/*.{json,yml}',
|
438
|
+
helpers: 'src/custom-helpers.js',
|
439
|
+
partials: ['src/partials/**/*.{hbs,md}']
|
440
|
+
},
|
441
|
+
pages: {
|
442
|
+
options: {
|
443
|
+
layout: 'default.hbs'
|
444
|
+
},
|
445
|
+
files: {
|
446
|
+
'./': ['src/templates/pages/index.hbs']
|
447
|
+
}
|
448
|
+
}
|
449
|
+
}
|
450
|
+
};
|
451
|
+
```
|
452
|
+
</pre>
|
453
|
+
|
454
|
+
Renders to:
|
455
|
+
|
456
|
+
```js
|
457
|
+
grunt.initConfig({
|
458
|
+
assemble: {
|
459
|
+
options: {
|
460
|
+
assets: 'docs/assets',
|
461
|
+
data: 'src/data/*.{json,yml}',
|
462
|
+
helpers: 'src/custom-helpers.js',
|
463
|
+
partials: ['src/partials/**/*.{hbs,md}']
|
464
|
+
},
|
465
|
+
pages: {
|
466
|
+
options: {
|
467
|
+
layout: 'default.hbs'
|
468
|
+
},
|
469
|
+
files: {
|
470
|
+
'./': ['src/templates/pages/index.hbs']
|
471
|
+
}
|
472
|
+
}
|
473
|
+
}
|
474
|
+
};
|
475
|
+
```
|
476
|
+
|
477
|
+
## Tables
|
478
|
+
Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
|
479
|
+
|
480
|
+
|
481
|
+
```markdown
|
482
|
+
| Option | Description |
|
483
|
+
| ------ | ----------- |
|
484
|
+
| data | path to data files to supply the data that will be passed into templates. |
|
485
|
+
| engine | engine to be used for processing templates. Handlebars is the default. |
|
486
|
+
| ext | extension to be used for dest files. |
|
487
|
+
```
|
488
|
+
|
489
|
+
Renders to:
|
490
|
+
|
491
|
+
| Option | Description |
|
492
|
+
| ------ | ----------- |
|
493
|
+
| data | path to data files to supply the data that will be passed into templates. |
|
494
|
+
| engine | engine to be used for processing templates. Handlebars is the default. |
|
495
|
+
| ext | extension to be used for dest files. |
|
496
|
+
|
497
|
+
And this HTML:
|
498
|
+
|
499
|
+
```html
|
500
|
+
<table>
|
501
|
+
<tr>
|
502
|
+
<th>Option</th>
|
503
|
+
<th>Description</th>
|
504
|
+
</tr>
|
505
|
+
<tr>
|
506
|
+
<td>data</td>
|
507
|
+
<td>path to data files to supply the data that will be passed into templates.</td>
|
508
|
+
</tr>
|
509
|
+
<tr>
|
510
|
+
<td>engine</td>
|
511
|
+
<td>engine to be used for processing templates. Handlebars is the default.</td>
|
512
|
+
</tr>
|
513
|
+
<tr>
|
514
|
+
<td>ext</td>
|
515
|
+
<td>extension to be used for dest files.</td>
|
516
|
+
</tr>
|
517
|
+
</table>
|
518
|
+
```
|
519
|
+
|
520
|
+
### Right aligned text
|
521
|
+
|
522
|
+
Adding a colon on the right side of the dashes below any heading will right align text for that column.
|
523
|
+
|
524
|
+
```markdown
|
525
|
+
| Option | Description |
|
526
|
+
| ------:| -----------:|
|
527
|
+
| data | path to data files to supply the data that will be passed into templates. |
|
528
|
+
| engine | engine to be used for processing templates. Handlebars is the default. |
|
529
|
+
| ext | extension to be used for dest files. |
|
530
|
+
```
|
531
|
+
|
532
|
+
| Option | Description |
|
533
|
+
| ------:| -----------:|
|
534
|
+
| data | path to data files to supply the data that will be passed into templates. |
|
535
|
+
| engine | engine to be used for processing templates. Handlebars is the default. |
|
536
|
+
| ext | extension to be used for dest files. |
|
537
|
+
|
538
|
+
## Links
|
539
|
+
|
540
|
+
### Basic link
|
541
|
+
|
542
|
+
```markdown
|
543
|
+
[Assemble](http://assemble.io)
|
544
|
+
```
|
545
|
+
|
546
|
+
Renders to (hover over the link, there is no tooltip):
|
547
|
+
|
548
|
+
[Assemble](http://assemble.io)
|
549
|
+
|
550
|
+
HTML:
|
551
|
+
|
552
|
+
```html
|
553
|
+
<a href="http://assemble.io">Assemble</a>
|
554
|
+
```
|
555
|
+
|
556
|
+
|
557
|
+
### Add a title
|
558
|
+
|
559
|
+
```markdown
|
560
|
+
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
561
|
+
```
|
562
|
+
|
563
|
+
Renders to (hover over the link, there should be a tooltip):
|
564
|
+
|
565
|
+
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
566
|
+
|
567
|
+
HTML:
|
568
|
+
|
569
|
+
```html
|
570
|
+
<a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>
|
571
|
+
```
|
572
|
+
|
573
|
+
### Named Anchors
|
574
|
+
|
575
|
+
Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:
|
576
|
+
|
577
|
+
```markdown
|
578
|
+
# Table of Contents
|
579
|
+
* [Chapter 1](#chapter-1)
|
580
|
+
* [Chapter 2](#chapter-2)
|
581
|
+
* [Chapter 3](#chapter-3)
|
582
|
+
```
|
583
|
+
will jump to these sections:
|
584
|
+
|
585
|
+
```markdown
|
586
|
+
## Chapter 1 <a id="chapter-1"></a>
|
587
|
+
Content for chapter one.
|
588
|
+
|
589
|
+
## Chapter 2 <a id="chapter-2"></a>
|
590
|
+
Content for chapter one.
|
591
|
+
|
592
|
+
## Chapter 3 <a id="chapter-3"></a>
|
593
|
+
Content for chapter one.
|
594
|
+
```
|
595
|
+
**NOTE** that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.
|
596
|
+
|
597
|
+
## Images {#images}
|
598
|
+
Images have a similar syntax to links but include a preceding exclamation point.
|
599
|
+
|
600
|
+
```markdown
|
601
|
+
![Minion](https://octodex.github.com/images/minion.png)
|
602
|
+
```
|
603
|
+
![Minion](https://octodex.github.com/images/minion.png)
|
604
|
+
|
605
|
+
or
|
606
|
+
```markdown
|
607
|
+
![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
|
608
|
+
```
|
609
|
+
![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
|
610
|
+
|
611
|
+
Like links, Images also have a footnote style syntax
|
612
|
+
|
613
|
+
### Alternative usage : note images
|
614
|
+
|
615
|
+
```markdown
|
616
|
+
![Alt text][id]
|
617
|
+
```
|
618
|
+
![Alt text][id]
|
619
|
+
|
620
|
+
With a reference later in the document defining the URL location:
|
621
|
+
|
622
|
+
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
623
|
+
|
624
|
+
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
625
|
+
|
626
|
+
### Resizing image
|
627
|
+
|
628
|
+
Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).
|
629
|
+
|
630
|
+
```markdown
|
631
|
+
![Minion](https://octodex.github.com/images/minion.png?width=20pc)
|
632
|
+
```
|
633
|
+
|
634
|
+
![Minion](https://octodex.github.com/images/minion.png?width=20pc)
|
635
|
+
|
636
|
+
```markdown
|
637
|
+
![Minion](https://octodex.github.com/images/minion.png?height=50px)
|
638
|
+
```
|
639
|
+
|
640
|
+
![Minion](https://octodex.github.com/images/minion.png?height=50px)
|
641
|
+
|
642
|
+
```markdown
|
643
|
+
![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px)
|
644
|
+
```
|
645
|
+
|
646
|
+
![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px)
|
647
|
+
|
648
|
+
### Add CSS classes
|
649
|
+
|
650
|
+
Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow`and `border` are available but you could define other ones.
|
651
|
+
|
652
|
+
```markdown
|
653
|
+
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow)
|
654
|
+
```
|
655
|
+
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=shadow)
|
656
|
+
|
657
|
+
```markdown
|
658
|
+
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border)
|
659
|
+
```
|
660
|
+
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border)
|
661
|
+
|
662
|
+
```markdown
|
663
|
+
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow)
|
664
|
+
```
|
665
|
+
![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border,shadow)
|