codefresh 0.88.2 → 0.88.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/interface/cli/completion/tree.json +1 -1
- package/package.json +17 -16
- package/.dockerignore +0 -15
- package/.eslintrc.js +0 -20
- package/.gitattributes +0 -29
- package/.github/CODEOWNERS +0 -1
- package/.github/pull_request_template.md +0 -5
- package/.github/release-drafter.yaml +0 -8
- package/.github/workflows/create-release.yaml +0 -36
- package/.github/workflows/draft-release.yaml +0 -33
- package/.nvmrc +0 -1
- package/Dockerfile +0 -44
- package/Dockerfile-debian +0 -49
- package/Dockerfile-debian-rootless +0 -58
- package/Dockerfile-rootless +0 -55
- package/__mocks__/codefresh.yml +0 -40
- package/__mocks__/requestretry.js +0 -35
- package/cli.gif +0 -0
- package/codefresh-v0.88.2-alpine-arm64.tar.gz +0 -0
- package/codefresh-v0.88.2-alpine-x64.tar.gz +0 -0
- package/codefresh-v0.88.2-linux-arm64.tar.gz +0 -0
- package/codefresh-v0.88.2-linux-x64.tar.gz +0 -0
- package/codefresh-v0.88.2-macos-x64.tar.gz +0 -0
- package/docs/archetypes/default.md +0 -6
- package/docs/config.toml +0 -44
- package/docs/content/_header.md +0 -6
- package/docs/content/_index.md +0 -19
- package/docs/content/contexts/spec/_index.md +0 -28
- package/docs/content/contexts/spec/config.md +0 -30
- package/docs/content/contexts/spec/helm-repository.md +0 -16
- package/docs/content/contexts/spec/secret-yaml.md +0 -32
- package/docs/content/contexts/spec/secret.md +0 -30
- package/docs/content/contexts/spec/yaml.md +0 -30
- package/docs/content/external-resources.md +0 -8
- package/docs/content/getting-started/_index.md +0 -28
- package/docs/content/installation/_index.md +0 -13
- package/docs/content/installation/docker.md +0 -15
- package/docs/content/installation/homebrew.md +0 -29
- package/docs/content/installation/npm.md +0 -22
- package/docs/content/installation/yarn.md +0 -22
- package/docs/content/more/_index.md +0 -7
- package/docs/content/operate on resources/_index.md +0 -10
- package/docs/content/pipelines/Run Pipeline.md +0 -38
- package/docs/content/pipelines/spec.md +0 -264
- package/docs/docs.spec.js +0 -8
- package/docs/index.js +0 -431
- package/docs/layouts/partials/menu-footer.html +0 -13
- package/docs/themes/docdock/LICENSE.md +0 -22
- package/docs/themes/docdock/README.md +0 -129
- package/docs/themes/docdock/archetypes/default.md +0 -9
- package/docs/themes/docdock/archetypes/slide.md +0 -46
- package/docs/themes/docdock/exampleSite/config.toml +0 -68
- package/docs/themes/docdock/exampleSite/content/_index.md +0 -50
- package/docs/themes/docdock/exampleSite/content/content-organisation/_index.md +0 -138
- package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/_index.md +0 -66
- package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/disable.md +0 -24
- package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/theme-variants.md +0 -35
- package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/themestyle.md +0 -25
- package/docs/themes/docdock/exampleSite/content/content-organisation/extramenu.md +0 -28
- package/docs/themes/docdock/exampleSite/content/content-organisation/logo.md +0 -12
- package/docs/themes/docdock/exampleSite/content/create-page/_index.md +0 -54
- package/docs/themes/docdock/exampleSite/content/create-page/homepage.md +0 -8
- package/docs/themes/docdock/exampleSite/content/create-page/myslide.md +0 -48
- package/docs/themes/docdock/exampleSite/content/create-page/page-images.md +0 -28
- package/docs/themes/docdock/exampleSite/content/create-page/page-slide.md +0 -114
- package/docs/themes/docdock/exampleSite/content/credits.md +0 -44
- package/docs/themes/docdock/exampleSite/content/getting-start/_index.md +0 -12
- package/docs/themes/docdock/exampleSite/content/getting-start/configuration.md +0 -56
- package/docs/themes/docdock/exampleSite/content/getting-start/installation.md +0 -83
- package/docs/themes/docdock/exampleSite/content/search/_index.md +0 -13
- package/docs/themes/docdock/exampleSite/content/shortcodes/_index.md +0 -10
- package/docs/themes/docdock/exampleSite/content/shortcodes/alert.md +0 -30
- package/docs/themes/docdock/exampleSite/content/shortcodes/attachments.files/BachGavotteShort.mp3 +0 -0
- package/docs/themes/docdock/exampleSite/content/shortcodes/attachments.files/Carroll_AliceAuPaysDesMerveilles.pdf +0 -0
- package/docs/themes/docdock/exampleSite/content/shortcodes/attachments.files/adivorciarsetoca00cape.pdf +0 -0
- package/docs/themes/docdock/exampleSite/content/shortcodes/attachments.files/hugo.png +0 -0
- package/docs/themes/docdock/exampleSite/content/shortcodes/attachments.files/movieselectricsheep-flock-244-32500-2.mp4 +0 -0
- package/docs/themes/docdock/exampleSite/content/shortcodes/attachments.md +0 -59
- package/docs/themes/docdock/exampleSite/content/shortcodes/button.md +0 -37
- package/docs/themes/docdock/exampleSite/content/shortcodes/children/_index.md +0 -46
- package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-1/_index.md +0 -6
- package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.md +0 -6
- package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.md +0 -6
- package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.md +0 -6
- package/docs/themes/docdock/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.md +0 -6
- package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-2/_index.md +0 -11
- package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-2/test3.md +0 -6
- package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-3/_index.md +0 -6
- package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-4/_index.md +0 -7
- package/docs/themes/docdock/exampleSite/content/shortcodes/children/test.md +0 -6
- package/docs/themes/docdock/exampleSite/content/shortcodes/excerpt-include.md +0 -25
- package/docs/themes/docdock/exampleSite/content/shortcodes/excerpt.md +0 -39
- package/docs/themes/docdock/exampleSite/content/shortcodes/expand.md +0 -41
- package/docs/themes/docdock/exampleSite/content/shortcodes/icon.md +0 -1254
- package/docs/themes/docdock/exampleSite/content/shortcodes/mermaid.md +0 -98
- package/docs/themes/docdock/exampleSite/content/shortcodes/notice.md +0 -61
- package/docs/themes/docdock/exampleSite/content/shortcodes/panel.md +0 -60
- package/docs/themes/docdock/exampleSite/content/shortcodes/revealjs.md +0 -119
- package/docs/themes/docdock/exampleSite/content/showcase.md +0 -15
- package/docs/themes/docdock/exampleSite/layouts/partials/custom-head.html +0 -10
- package/docs/themes/docdock/exampleSite/layouts/partials/menu-footer.html +0 -13
- package/docs/themes/docdock/exampleSite/layouts/shortcodes/ghcontributors.html +0 -31
- package/docs/themes/docdock/exampleSite/static/menu-entry-icon.png +0 -0
- package/docs/themes/docdock/exampleSite/static/showcase/bitfan.site.png +0 -0
- package/docs/themes/docdock/exampleSite/static/showcase/invincible.site.png +0 -0
- package/docs/themes/docdock/exampleSite/static/style-flex.png +0 -0
- package/docs/themes/docdock/exampleSite/static/style-original.png +0 -0
- package/docs/themes/docdock/exampleSite/static/variant-gold.png +0 -0
- package/docs/themes/docdock/exampleSite/static/variant-gray.png +0 -0
- package/docs/themes/docdock/exampleSite/static/variant-green.png +0 -0
- package/docs/themes/docdock/i18n/en.toml +0 -44
- package/docs/themes/docdock/i18n/es.toml +0 -26
- package/docs/themes/docdock/i18n/fr.toml +0 -44
- package/docs/themes/docdock/i18n/nb.toml +0 -38
- package/docs/themes/docdock/images/screenshot.png +0 -0
- package/docs/themes/docdock/images/tn.png +0 -0
- package/docs/themes/docdock/layouts/404.html +0 -39
- package/docs/themes/docdock/layouts/_default/baseof.html +0 -32
- package/docs/themes/docdock/layouts/_default/li.html +0 -22
- package/docs/themes/docdock/layouts/_default/list.html +0 -20
- package/docs/themes/docdock/layouts/_default/single.html +0 -3
- package/docs/themes/docdock/layouts/index.html +0 -30
- package/docs/themes/docdock/layouts/index.json +0 -12
- package/docs/themes/docdock/layouts/partials/breadcrumb.html +0 -8
- package/docs/themes/docdock/layouts/partials/custom-content-footer.html +0 -6
- package/docs/themes/docdock/layouts/partials/custom-footer.html +0 -0
- package/docs/themes/docdock/layouts/partials/custom-head.html +0 -2
- package/docs/themes/docdock/layouts/partials/flex/body-aftercontent.html +0 -54
- package/docs/themes/docdock/layouts/partials/flex/body-beforecontent.html +0 -68
- package/docs/themes/docdock/layouts/partials/flex/head.html +0 -17
- package/docs/themes/docdock/layouts/partials/flex/scripts.html +0 -11
- package/docs/themes/docdock/layouts/partials/flex/selectnavigation.html +0 -58
- package/docs/themes/docdock/layouts/partials/header.html +0 -10
- package/docs/themes/docdock/layouts/partials/language-selector.html +0 -18
- package/docs/themes/docdock/layouts/partials/menu-footer.html +0 -0
- package/docs/themes/docdock/layouts/partials/menu.html +0 -82
- package/docs/themes/docdock/layouts/partials/next-prev-page.html +0 -44
- package/docs/themes/docdock/layouts/partials/original/body-aftercontent.html +0 -13
- package/docs/themes/docdock/layouts/partials/original/body-beforecontent.html +0 -128
- package/docs/themes/docdock/layouts/partials/original/head.html +0 -23
- package/docs/themes/docdock/layouts/partials/original/scripts.html +0 -10
- package/docs/themes/docdock/layouts/partials/pagination.html +0 -9
- package/docs/themes/docdock/layouts/shortcodes/alert.html +0 -6
- package/docs/themes/docdock/layouts/shortcodes/anchor.html +0 -1
- package/docs/themes/docdock/layouts/shortcodes/anchorlink.html +0 -1
- package/docs/themes/docdock/layouts/shortcodes/attachmentlink.html +0 -5
- package/docs/themes/docdock/layouts/shortcodes/attachments.html +0 -33
- package/docs/themes/docdock/layouts/shortcodes/button.html +0 -6
- package/docs/themes/docdock/layouts/shortcodes/children.html +0 -104
- package/docs/themes/docdock/layouts/shortcodes/code.html +0 -1
- package/docs/themes/docdock/layouts/shortcodes/emoticon.html +0 -29
- package/docs/themes/docdock/layouts/shortcodes/excerpt-include.html +0 -14
- package/docs/themes/docdock/layouts/shortcodes/excerpt.html +0 -7
- package/docs/themes/docdock/layouts/shortcodes/expand.html +0 -16
- package/docs/themes/docdock/layouts/shortcodes/header.html +0 -16
- package/docs/themes/docdock/layouts/shortcodes/icon.html +0 -13
- package/docs/themes/docdock/layouts/shortcodes/image.html +0 -5
- package/docs/themes/docdock/layouts/shortcodes/info.html +0 -10
- package/docs/themes/docdock/layouts/shortcodes/label.html +0 -1
- package/docs/themes/docdock/layouts/shortcodes/mermaid.html +0 -3
- package/docs/themes/docdock/layouts/shortcodes/note.html +0 -4
- package/docs/themes/docdock/layouts/shortcodes/notice.html +0 -1
- package/docs/themes/docdock/layouts/shortcodes/pagelink.html +0 -12
- package/docs/themes/docdock/layouts/shortcodes/pagetreesearch.html +0 -1
- package/docs/themes/docdock/layouts/shortcodes/panel.html +0 -5
- package/docs/themes/docdock/layouts/shortcodes/recently-updated.html +0 -7
- package/docs/themes/docdock/layouts/shortcodes/relref.html +0 -14
- package/docs/themes/docdock/layouts/shortcodes/revealjs.html +0 -66
- package/docs/themes/docdock/layouts/shortcodes/section.html +0 -1
- package/docs/themes/docdock/layouts/shortcodes/task.html +0 -10
- package/docs/themes/docdock/layouts/shortcodes/tasklist.html +0 -4
- package/docs/themes/docdock/layouts/shortcodes/tip.html +0 -10
- package/docs/themes/docdock/layouts/shortcodes/toc.html +0 -2
- package/docs/themes/docdock/layouts/shortcodes/unknow.html +0 -1
- package/docs/themes/docdock/layouts/shortcodes/userlink.html +0 -1
- package/docs/themes/docdock/layouts/shortcodes/viewppt.html +0 -5
- package/docs/themes/docdock/layouts/shortcodes/viewxls.html +0 -5
- package/docs/themes/docdock/layouts/shortcodes/warning.html +0 -12
- package/docs/themes/docdock/layouts/shortcodes/well.html +0 -1
- package/docs/themes/docdock/layouts/slide/single.html +0 -38
- package/docs/themes/docdock/static/css/auto-complete.css +0 -49
- package/docs/themes/docdock/static/css/bootstrap.min.css +0 -1884
- package/docs/themes/docdock/static/css/featherlight.min.css +0 -8
- package/docs/themes/docdock/static/css/font-awesome.min.css +0 -4
- package/docs/themes/docdock/static/css/horsey.css +0 -35
- package/docs/themes/docdock/static/css/hybrid.css +0 -102
- package/docs/themes/docdock/static/css/nucleus.css +0 -617
- package/docs/themes/docdock/static/fonts/FontAwesome.otf +0 -0
- package/docs/themes/docdock/static/fonts/Inconsolata.eot +0 -0
- package/docs/themes/docdock/static/fonts/Inconsolata.svg +0 -359
- package/docs/themes/docdock/static/fonts/Inconsolata.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Inconsolata.woff +0 -0
- package/docs/themes/docdock/static/fonts/Lato-Bold.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Lato-Bold.woff2 +0 -0
- package/docs/themes/docdock/static/fonts/Lato-Regular.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Lato-Regular.woff2 +0 -0
- package/docs/themes/docdock/static/fonts/Novecentosanswide-Normal-webfont.eot +0 -0
- package/docs/themes/docdock/static/fonts/Novecentosanswide-Normal-webfont.svg +0 -1019
- package/docs/themes/docdock/static/fonts/Novecentosanswide-Normal-webfont.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Novecentosanswide-Normal-webfont.woff +0 -0
- package/docs/themes/docdock/static/fonts/Novecentosanswide-Normal-webfont.woff2 +0 -0
- package/docs/themes/docdock/static/fonts/Novecentosanswide-UltraLight-webfont.eot +0 -0
- package/docs/themes/docdock/static/fonts/Novecentosanswide-UltraLight-webfont.svg +0 -918
- package/docs/themes/docdock/static/fonts/Novecentosanswide-UltraLight-webfont.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Novecentosanswide-UltraLight-webfont.woff +0 -0
- package/docs/themes/docdock/static/fonts/Novecentosanswide-UltraLight-webfont.woff2 +0 -0
- package/docs/themes/docdock/static/fonts/Roboto-Italic.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Roboto-Medium.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Roboto-Regular.ttf +0 -0
- package/docs/themes/docdock/static/fonts/RobotoMono-Medium.ttf +0 -0
- package/docs/themes/docdock/static/fonts/RobotoMono-Regular.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_200.eot +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_200.svg +0 -332
- package/docs/themes/docdock/static/fonts/Work_Sans_200.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_200.woff +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_200.woff2 +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_300.eot +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_300.svg +0 -331
- package/docs/themes/docdock/static/fonts/Work_Sans_300.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_300.woff +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_300.woff2 +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_500.eot +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_500.svg +0 -333
- package/docs/themes/docdock/static/fonts/Work_Sans_500.ttf +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_500.woff +0 -0
- package/docs/themes/docdock/static/fonts/Work_Sans_500.woff2 +0 -0
- package/docs/themes/docdock/static/fonts/fontawesome-webfont.eot +0 -0
- package/docs/themes/docdock/static/fonts/fontawesome-webfont.svg +0 -2671
- package/docs/themes/docdock/static/fonts/fontawesome-webfont.ttf +0 -0
- package/docs/themes/docdock/static/fonts/fontawesome-webfont.woff +0 -0
- package/docs/themes/docdock/static/fonts/fontawesome-webfont.woff2 +0 -0
- package/docs/themes/docdock/static/fonts/glyphicons-halflings-regular.eot +0 -0
- package/docs/themes/docdock/static/fonts/glyphicons-halflings-regular.svg +0 -288
- package/docs/themes/docdock/static/fonts/glyphicons-halflings-regular.ttf +0 -0
- package/docs/themes/docdock/static/fonts/glyphicons-halflings-regular.woff +0 -0
- package/docs/themes/docdock/static/fonts/glyphicons-halflings-regular.woff2 +0 -0
- package/docs/themes/docdock/static/images/clippy.svg +0 -4
- package/docs/themes/docdock/static/images/favicon.png +0 -0
- package/docs/themes/docdock/static/images/gopher-404.jpg +0 -0
- package/docs/themes/docdock/static/js/auto-complete.js +0 -223
- package/docs/themes/docdock/static/js/clipboard.min.js +0 -7
- package/docs/themes/docdock/static/js/docdock.js +0 -309
- package/docs/themes/docdock/static/js/featherlight.min.js +0 -8
- package/docs/themes/docdock/static/js/highlight.pack.js +0 -2
- package/docs/themes/docdock/static/js/html5shiv-printshiv.min.js +0 -4
- package/docs/themes/docdock/static/js/jquery-2.x.min.js +0 -4
- package/docs/themes/docdock/static/js/lunr.min.js +0 -6
- package/docs/themes/docdock/static/js/modernizr.custom.71422.js +0 -4
- package/docs/themes/docdock/static/js/search.js +0 -91
- package/docs/themes/docdock/static/mermaid/mermaid.css +0 -273
- package/docs/themes/docdock/static/mermaid/mermaid.dark.css +0 -275
- package/docs/themes/docdock/static/mermaid/mermaid.forest.css +0 -353
- package/docs/themes/docdock/static/mermaid/mermaid.js +0 -30
- package/docs/themes/docdock/static/none.html +0 -0
- package/docs/themes/docdock/static/revealjs/.travis.yml +0 -5
- package/docs/themes/docdock/static/revealjs/CONTRIBUTING.md +0 -23
- package/docs/themes/docdock/static/revealjs/Gruntfile.js +0 -192
- package/docs/themes/docdock/static/revealjs/LICENSE +0 -19
- package/docs/themes/docdock/static/revealjs/README.md +0 -1238
- package/docs/themes/docdock/static/revealjs/bower.json +0 -27
- package/docs/themes/docdock/static/revealjs/css/print/paper.css +0 -203
- package/docs/themes/docdock/static/revealjs/css/print/pdf.css +0 -178
- package/docs/themes/docdock/static/revealjs/css/reveal.css +0 -1555
- package/docs/themes/docdock/static/revealjs/css/reveal.scss +0 -1717
- package/docs/themes/docdock/static/revealjs/css/theme/README.md +0 -21
- package/docs/themes/docdock/static/revealjs/css/theme/beige.css +0 -268
- package/docs/themes/docdock/static/revealjs/css/theme/black.css +0 -264
- package/docs/themes/docdock/static/revealjs/css/theme/blood.css +0 -287
- package/docs/themes/docdock/static/revealjs/css/theme/league.css +0 -270
- package/docs/themes/docdock/static/revealjs/css/theme/moon.css +0 -268
- package/docs/themes/docdock/static/revealjs/css/theme/night.css +0 -262
- package/docs/themes/docdock/static/revealjs/css/theme/serif.css +0 -264
- package/docs/themes/docdock/static/revealjs/css/theme/simple.css +0 -267
- package/docs/themes/docdock/static/revealjs/css/theme/sky.css +0 -271
- package/docs/themes/docdock/static/revealjs/css/theme/solarized.css +0 -268
- package/docs/themes/docdock/static/revealjs/css/theme/source/beige.scss +0 -39
- package/docs/themes/docdock/static/revealjs/css/theme/source/black.scss +0 -49
- package/docs/themes/docdock/static/revealjs/css/theme/source/blood.scss +0 -78
- package/docs/themes/docdock/static/revealjs/css/theme/source/league.scss +0 -34
- package/docs/themes/docdock/static/revealjs/css/theme/source/moon.scss +0 -57
- package/docs/themes/docdock/static/revealjs/css/theme/source/night.scss +0 -34
- package/docs/themes/docdock/static/revealjs/css/theme/source/serif.scss +0 -35
- package/docs/themes/docdock/static/revealjs/css/theme/source/simple.scss +0 -43
- package/docs/themes/docdock/static/revealjs/css/theme/source/sky.scss +0 -46
- package/docs/themes/docdock/static/revealjs/css/theme/source/solarized.scss +0 -63
- package/docs/themes/docdock/static/revealjs/css/theme/source/white.scss +0 -49
- package/docs/themes/docdock/static/revealjs/css/theme/template/mixins.scss +0 -29
- package/docs/themes/docdock/static/revealjs/css/theme/template/settings.scss +0 -43
- package/docs/themes/docdock/static/revealjs/css/theme/template/theme.scss +0 -316
- package/docs/themes/docdock/static/revealjs/css/theme/white.css +0 -264
- package/docs/themes/docdock/static/revealjs/demo.html +0 -410
- package/docs/themes/docdock/static/revealjs/index.html +0 -49
- package/docs/themes/docdock/static/revealjs/js/reveal.js +0 -5239
- package/docs/themes/docdock/static/revealjs/lib/css/zenburn.css +0 -80
- package/docs/themes/docdock/static/revealjs/lib/font/league-gothic/LICENSE +0 -2
- package/docs/themes/docdock/static/revealjs/lib/font/league-gothic/league-gothic.css +0 -10
- package/docs/themes/docdock/static/revealjs/lib/font/league-gothic/league-gothic.eot +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/league-gothic/league-gothic.ttf +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/league-gothic/league-gothic.woff +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/LICENSE +0 -45
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-italic.eot +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-italic.ttf +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-italic.woff +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-regular.eot +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-regular.ttf +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-regular.woff +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-semibold.eot +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-semibold.ttf +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-semibold.woff +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-semibolditalic.eot +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-semibolditalic.ttf +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro-semibolditalic.woff +0 -0
- package/docs/themes/docdock/static/revealjs/lib/font/source-sans-pro/source-sans-pro.css +0 -39
- package/docs/themes/docdock/static/revealjs/lib/js/classList.js +0 -2
- package/docs/themes/docdock/static/revealjs/lib/js/head.min.js +0 -9
- package/docs/themes/docdock/static/revealjs/lib/js/html5shiv.js +0 -7
- package/docs/themes/docdock/static/revealjs/package.json +0 -43
- package/docs/themes/docdock/static/revealjs/plugin/highlight/highlight.js +0 -77
- package/docs/themes/docdock/static/revealjs/plugin/markdown/example.html +0 -129
- package/docs/themes/docdock/static/revealjs/plugin/markdown/example.md +0 -31
- package/docs/themes/docdock/static/revealjs/plugin/markdown/markdown.js +0 -412
- package/docs/themes/docdock/static/revealjs/plugin/markdown/marked.js +0 -6
- package/docs/themes/docdock/static/revealjs/plugin/math/math.js +0 -67
- package/docs/themes/docdock/static/revealjs/plugin/multiplex/client.js +0 -13
- package/docs/themes/docdock/static/revealjs/plugin/multiplex/index.js +0 -64
- package/docs/themes/docdock/static/revealjs/plugin/multiplex/master.js +0 -34
- package/docs/themes/docdock/static/revealjs/plugin/multiplex/package.json +0 -19
- package/docs/themes/docdock/static/revealjs/plugin/notes/notes.html +0 -759
- package/docs/themes/docdock/static/revealjs/plugin/notes/notes.js +0 -155
- package/docs/themes/docdock/static/revealjs/plugin/notes-server/client.js +0 -65
- package/docs/themes/docdock/static/revealjs/plugin/notes-server/index.js +0 -69
- package/docs/themes/docdock/static/revealjs/plugin/notes-server/notes.html +0 -585
- package/docs/themes/docdock/static/revealjs/plugin/print-pdf/print-pdf.js +0 -69
- package/docs/themes/docdock/static/revealjs/plugin/search/search.js +0 -206
- package/docs/themes/docdock/static/revealjs/plugin/zoom-js/zoom.js +0 -272
- package/docs/themes/docdock/static/revealjs/test/examples/assets/image1.png +0 -0
- package/docs/themes/docdock/static/revealjs/test/examples/assets/image2.png +0 -0
- package/docs/themes/docdock/static/revealjs/test/examples/barebones.html +0 -41
- package/docs/themes/docdock/static/revealjs/test/examples/embedded-media.html +0 -49
- package/docs/themes/docdock/static/revealjs/test/examples/math.html +0 -185
- package/docs/themes/docdock/static/revealjs/test/examples/slide-backgrounds.html +0 -144
- package/docs/themes/docdock/static/revealjs/test/examples/slide-transitions.html +0 -101
- package/docs/themes/docdock/static/revealjs/test/qunit-1.12.0.css +0 -244
- package/docs/themes/docdock/static/revealjs/test/qunit-1.12.0.js +0 -2212
- package/docs/themes/docdock/static/revealjs/test/simple.md +0 -12
- package/docs/themes/docdock/static/revealjs/test/test-markdown-element-attributes.html +0 -134
- package/docs/themes/docdock/static/revealjs/test/test-markdown-element-attributes.js +0 -46
- package/docs/themes/docdock/static/revealjs/test/test-markdown-external.html +0 -36
- package/docs/themes/docdock/static/revealjs/test/test-markdown-external.js +0 -24
- package/docs/themes/docdock/static/revealjs/test/test-markdown-options.html +0 -41
- package/docs/themes/docdock/static/revealjs/test/test-markdown-options.js +0 -26
- package/docs/themes/docdock/static/revealjs/test/test-markdown-slide-attributes.html +0 -128
- package/docs/themes/docdock/static/revealjs/test/test-markdown-slide-attributes.js +0 -47
- package/docs/themes/docdock/static/revealjs/test/test-markdown.html +0 -52
- package/docs/themes/docdock/static/revealjs/test/test-markdown.js +0 -15
- package/docs/themes/docdock/static/revealjs/test/test-pdf.html +0 -83
- package/docs/themes/docdock/static/revealjs/test/test-pdf.js +0 -15
- package/docs/themes/docdock/static/revealjs/test/test.html +0 -86
- package/docs/themes/docdock/static/revealjs/test/test.js +0 -597
- package/docs/themes/docdock/static/scss/flex/article.scss +0 -356
- package/docs/themes/docdock/static/scss/flex/fonts.scss +0 -38
- package/docs/themes/docdock/static/scss/flex/footer.scss +0 -45
- package/docs/themes/docdock/static/scss/flex/header.scss +0 -89
- package/docs/themes/docdock/static/scss/flex/main.scss +0 -164
- package/docs/themes/docdock/static/scss/flex/medias.scss +0 -74
- package/docs/themes/docdock/static/scss/flex/menu.scss +0 -126
- package/docs/themes/docdock/static/scss/flex/shortcode.children.scss +0 -34
- package/docs/themes/docdock/static/scss/flex/shortcode.notice.scss +0 -63
- package/docs/themes/docdock/static/scss/flex/style.scss +0 -14
- package/docs/themes/docdock/static/scss/original/_colours.scss +0 -14
- package/docs/themes/docdock/static/scss/original/_functions.scss +0 -89
- package/docs/themes/docdock/static/scss/original/_variables.scss +0 -137
- package/docs/themes/docdock/static/scss/original/fonts.scss +0 -23
- package/docs/themes/docdock/static/scss/original/main.scss +0 -1233
- package/docs/themes/docdock/static/scss/original/print.scss +0 -29
- package/docs/themes/docdock/static/scss/original/responsive.scss +0 -124
- package/docs/themes/docdock/static/scss/original/shortcodes.scss +0 -32
- package/docs/themes/docdock/static/scss/original/sidebar.scss +0 -276
- package/docs/themes/docdock/static/scss/original/style.scss +0 -16
- package/docs/themes/docdock/static/theme-flex/ribbon.png +0 -0
- package/docs/themes/docdock/static/theme-flex/script.js +0 -277
- package/docs/themes/docdock/static/theme-flex/style.css +0 -728
- package/docs/themes/docdock/static/theme-original/script.js +0 -133
- package/docs/themes/docdock/static/theme-original/style.css +0 -1411
- package/docs/themes/docdock/static/theme-original/variant-blue.css +0 -0
- package/docs/themes/docdock/static/theme-original/variant-gold.css +0 -61
- package/docs/themes/docdock/static/theme-original/variant-gray.css +0 -61
- package/docs/themes/docdock/static/theme-original/variant-green.css +0 -61
- package/docs/themes/docdock/theme.toml +0 -22
- package/e2e/README.md +0 -10
- package/e2e/data/crud.pip.yaml +0 -23
- package/e2e/data/test-run.pip.yaml +0 -23
- package/e2e/e2e.spec.sh +0 -25
- package/e2e/helpers.sh +0 -10
- package/e2e/scenarios/agents.sh +0 -1
- package/e2e/scenarios/annotations.sh +0 -2
- package/e2e/scenarios/boards.sh +0 -3
- package/e2e/scenarios/builds.sh +0 -1
- package/e2e/scenarios/clusters.sh +0 -1
- package/e2e/scenarios/compositions.sh +0 -1
- package/e2e/scenarios/contexts.sh +0 -1
- package/e2e/scenarios/environments.sh +0 -1
- package/e2e/scenarios/helm-repo.sh +0 -1
- package/e2e/scenarios/images.sh +0 -1
- package/e2e/scenarios/pipeline-run.sh +0 -26
- package/e2e/scenarios/pipelines.sh +0 -31
- package/e2e/scenarios/projects.sh +0 -17
- package/e2e/scenarios/registry.sh +0 -1
- package/e2e/scenarios/repository.sh +0 -2
- package/e2e/scenarios/runtime-environment.sh +0 -1
- package/e2e/scenarios/step-types.sh +0 -1
- package/e2e/scenarios/system-runtime-environments.sh +0 -1
- package/e2e/scenarios/teams.sh +0 -1
- package/e2e/scenarios/tokens.sh +0 -1
- package/e2e/scenarios/triggers.sh +0 -3
- package/test-setup.js +0 -34
- package/yarn.lock +0 -6767
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
The MIT License (MIT)
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2014 Grav
|
|
4
|
-
Copyright (c) 2016 MATHIEU CORNIC
|
|
5
|
-
Copyright (c) 2017 Valere JEANTET
|
|
6
|
-
|
|
7
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
8
|
-
this software and associated documentation files (the "Software"), to deal in
|
|
9
|
-
the Software without restriction, including without limitation the rights to
|
|
10
|
-
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
11
|
-
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
12
|
-
subject to the following conditions:
|
|
13
|
-
|
|
14
|
-
The above copyright notice and this permission notice shall be included in all
|
|
15
|
-
copies or substantial portions of the Software.
|
|
16
|
-
|
|
17
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
18
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
19
|
-
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
20
|
-
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
21
|
-
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
22
|
-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@@ -1,129 +0,0 @@
|
|
|
1
|
-
# Hugo docDock Theme
|
|
2
|
-
|
|
3
|
-
This repository contains a theme for [Hugo](https://gohugo.io/), based on
|
|
4
|
-
|
|
5
|
-
* [Matcornic Learn theme](https://github.com/matcornic/hugo-theme-learn/).
|
|
6
|
-
* [facette.io](https://facette.io/)'s documentation style css (Facette is a great time series data visualization software)
|
|
7
|
-
|
|
8
|
-
Visit the [theme documentation](http://docdock.netlify.com/) to see what is going on. It is actually built with this theme.
|
|
9
|
-
|
|
10
|
-
# Main features
|
|
11
|
-
|
|
12
|
-
- Search
|
|
13
|
-
- **Unlimited menu levels**
|
|
14
|
-
- RevealJS presentation from markdown (embededed or fullscreen page)
|
|
15
|
-
- Attachments files
|
|
16
|
-
- List child pages
|
|
17
|
-
- Include segment of content from one page in another (Excerpt)
|
|
18
|
-
- Automatic next/prev buttons to navigate through menu entries
|
|
19
|
-
- Mermaid diagram
|
|
20
|
-
- Icons, Buttons, Alerts, Panels, Tip/Note/Info/Warning boxes
|
|
21
|
-
- Image resizing, shadow...
|
|
22
|
-
- Customizable look and feel
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-

|
|
26
|
-
|
|
27
|
-
## Installation
|
|
28
|
-
|
|
29
|
-
Check that your Hugo version is minimum `0.30` with `hugo version`. We assume that all changes to Hugo content and customizations are going to be tracked by git (GitHub, Bitbucket etc.). Develop locally, build on remote system.
|
|
30
|
-
|
|
31
|
-
To start real work:
|
|
32
|
-
|
|
33
|
-
1. Initialize Hugo
|
|
34
|
-
2. Install DocDock theme
|
|
35
|
-
3. Configure DocDock and Hugo
|
|
36
|
-
|
|
37
|
-
### Prepare empty Hugo site
|
|
38
|
-
|
|
39
|
-
Create empty directory, which will be root of your Hugo project. Navigate there and let Hugo to create minimal required directory structure:
|
|
40
|
-
```
|
|
41
|
-
$ hugo new site .
|
|
42
|
-
```
|
|
43
|
-
AFTER that, initialize this as git directory where to track further changes
|
|
44
|
-
```
|
|
45
|
-
$ git init
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
Next, there are at least three ways to install DocDock (first recommended):
|
|
49
|
-
|
|
50
|
-
1. **As git submodule**
|
|
51
|
-
2. As git clone
|
|
52
|
-
3. As direct copy (from ZIP)
|
|
53
|
-
|
|
54
|
-
Navigate to your themes folder in your Hugo site and use perform one of following scenarios.
|
|
55
|
-
|
|
56
|
-
### 1. Install DocDock as git submodule
|
|
57
|
-
DocDock will be added like a dependency repo to original project. When using CI tools like Netlify, Jenkins etc., submodule method is required, or you will get `theme not found` issues. Same applies when building site on remote server trough SSH.
|
|
58
|
-
|
|
59
|
-
If submodule is no-go, use 3rd option.
|
|
60
|
-
|
|
61
|
-
On your root of Hugo execute:
|
|
62
|
-
|
|
63
|
-
```
|
|
64
|
-
$ git submodule add https://github.com/vjeantet/hugo-theme-docdock.git themes/docdock
|
|
65
|
-
```
|
|
66
|
-
Next initialize submodule for parent git repo:
|
|
67
|
-
|
|
68
|
-
```
|
|
69
|
-
$ git submodule init
|
|
70
|
-
$ git submodule update
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
Now you are ready to add content and customize looks. Do not change any file inside theme directory.
|
|
74
|
-
|
|
75
|
-
If you want to freeze changes to DocDock theme itself and use still submodules, fork private copy of DocDock and use that as submodule. When you are ready to update theme, just pull changes from origin to your private fork.
|
|
76
|
-
|
|
77
|
-
### 2. Install DocDock simply as git clone
|
|
78
|
-
This method results that files are checked out locally, but won't be visible from parent git repo. Probably you will build site locally with `hugo` command and use result from `public/` on your own.
|
|
79
|
-
|
|
80
|
-
```
|
|
81
|
-
$ git clone https://github.com/vjeantet/hugo-theme-docdock.git themes/docdock
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
### 3. Install DocDock from ZIP
|
|
86
|
-
|
|
87
|
-
All files from theme will be tracked inside parent repo, to update it, have to override files in theme. Download following zip and extract inside `themes/`.
|
|
88
|
-
|
|
89
|
-
```
|
|
90
|
-
https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip
|
|
91
|
-
```
|
|
92
|
-
Name of theme in next step will be `hugo-theme-docdock-master`, can rename as you wish.
|
|
93
|
-
|
|
94
|
-
## Configure
|
|
95
|
-
|
|
96
|
-
Import sample config from sample site to Hugo root.
|
|
97
|
-
|
|
98
|
-
```
|
|
99
|
-
$ cp themes/docdock/exampleSite/config.toml .
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
Change following `config.toml` line as needed, depending on method above:
|
|
103
|
-
```
|
|
104
|
-
theme = "<hugo-theme-docdock-dir-name>"
|
|
105
|
-
```
|
|
106
|
-
Comment out following line, so default `themes/` will be used:
|
|
107
|
-
|
|
108
|
-
```
|
|
109
|
-
# themesdir = "../.."
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
#### (Bonus)
|
|
113
|
-
Create empty file `.gitkeep` inside `public/` and add following to `.gitignore`. This way it will keep repo smaller and won't bring build result files and errors to remote checkout places:
|
|
114
|
-
```
|
|
115
|
-
/public/*
|
|
116
|
-
!/public/.gitkeep
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
### Preview site
|
|
120
|
-
```
|
|
121
|
-
$ hugo server
|
|
122
|
-
```
|
|
123
|
-
to browse site on http://localhost:1313
|
|
124
|
-
|
|
125
|
-
## Usage
|
|
126
|
-
|
|
127
|
-
- [Visit the documentation](http://docdock.netlify.com/)
|
|
128
|
-
- [Hugo docs](https://gohugo.io/getting-started/configuration/)
|
|
129
|
-
- [Git submodules](https://git-scm.com/docs/git-submodule)
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
+++
|
|
2
|
-
title = "Slide title"
|
|
3
|
-
type="slide"
|
|
4
|
-
|
|
5
|
-
theme = "league"
|
|
6
|
-
[revealOptions]
|
|
7
|
-
transition= 'concave'
|
|
8
|
-
controls= true
|
|
9
|
-
progress= true
|
|
10
|
-
history= true
|
|
11
|
-
center= true
|
|
12
|
-
+++
|
|
13
|
-
|
|
14
|
-
# Slide 1
|
|
15
|
-
|
|
16
|
-
___
|
|
17
|
-
|
|
18
|
-
## Slide 1.1
|
|
19
|
-
|
|
20
|
-
- Turn off alarm
|
|
21
|
-
- Get out of bed
|
|
22
|
-
|
|
23
|
-
___
|
|
24
|
-
|
|
25
|
-
## Slide 1.2
|
|
26
|
-
|
|
27
|
-
- Eat eggs
|
|
28
|
-
- Drink coffee
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
# Slide 2
|
|
33
|
-
|
|
34
|
-
___
|
|
35
|
-
|
|
36
|
-
## Slide 2.1
|
|
37
|
-
|
|
38
|
-
- Eat spaghetti
|
|
39
|
-
- Drink wine
|
|
40
|
-
|
|
41
|
-
___
|
|
42
|
-
|
|
43
|
-
## Slide 2.2
|
|
44
|
-
|
|
45
|
-
- Get in bed
|
|
46
|
-
- Count sheep
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
baseURL = "/"
|
|
2
|
-
|
|
3
|
-
languageCode = "en-us"
|
|
4
|
-
DefaultContentLanguage = "en"
|
|
5
|
-
title = "DocDock Documentation"
|
|
6
|
-
theme = "hugo-theme-docdock"
|
|
7
|
-
themesdir = "../.."
|
|
8
|
-
pygmentsCodeFences = true
|
|
9
|
-
pygmentsStyle = "monokailight"
|
|
10
|
-
|
|
11
|
-
defaultContentLanguage = "en"
|
|
12
|
-
defaultContentLanguageInSubdir= false
|
|
13
|
-
enableMissingTranslationPlaceholders = false
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
# [Languages]
|
|
17
|
-
# [Languages.en]
|
|
18
|
-
# title = "Documentation for Hugo docDock"
|
|
19
|
-
# weight = 1
|
|
20
|
-
# languageName = "English"
|
|
21
|
-
#
|
|
22
|
-
# [Languages.fr]
|
|
23
|
-
# title = "Documentation du thème docDock"
|
|
24
|
-
# weight = 2
|
|
25
|
-
# languageName = "Français"
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
[params]
|
|
31
|
-
editURL = "https://github.com/vjeantet/hugo-theme-docdock/edit/master/exampleSite/content/"
|
|
32
|
-
showVisitedLinks = true # default is false
|
|
33
|
-
themeStyle = "flex" # "original" or "flex" # default "flex"
|
|
34
|
-
themeVariant = "" # choose theme variant "green", "gold" , "gray", "blue" (default)
|
|
35
|
-
ordersectionsby = "weight" # ordersectionsby = "title"
|
|
36
|
-
disableHomeIcon = false # default is false
|
|
37
|
-
disableSearch = false # default is false
|
|
38
|
-
disableNavChevron = false # set true to hide next/prev chevron, default is false
|
|
39
|
-
highlightClientSide = false # set true to use highlight.pack.js instead of the default hugo chroma highlighter
|
|
40
|
-
menushortcutsnewtab = false # set true to open shortcuts links to a new tab/window
|
|
41
|
-
enableGitInfo = true
|
|
42
|
-
|
|
43
|
-
[outputs]
|
|
44
|
-
home = [ "HTML", "RSS", "JSON"]
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
[[menu.shortcuts]]
|
|
48
|
-
pre = "<h3>More</h3>"
|
|
49
|
-
name = "<i class='fa fa-github'></i> <label>Github repo</label>"
|
|
50
|
-
identifier = "ds"
|
|
51
|
-
url = "https://github.com/vjeantet/hugo-theme-docdock"
|
|
52
|
-
weight = 10
|
|
53
|
-
|
|
54
|
-
[[menu.shortcuts]]
|
|
55
|
-
name = "<i class='fa fa-cloud-download'></i> <label>Download</label>"
|
|
56
|
-
url = "https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip"
|
|
57
|
-
weight = 11
|
|
58
|
-
|
|
59
|
-
[[menu.shortcuts]]
|
|
60
|
-
name = "<i class='fa fa-bookmark'></i> <label>Hugo Documentation</label>"
|
|
61
|
-
identifier = "hugodoc"
|
|
62
|
-
url = "https://gohugo.io/"
|
|
63
|
-
weight = 20
|
|
64
|
-
|
|
65
|
-
[[menu.shortcuts]]
|
|
66
|
-
name = "<i class='fa fa-bullhorn'></i> <label>Credits</label>"
|
|
67
|
-
url = "/credits"
|
|
68
|
-
weight = 30
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
+++
|
|
2
|
-
title = "DocDock Theme for Hugo"
|
|
3
|
-
description = ""
|
|
4
|
-
+++
|
|
5
|
-
|
|
6
|
-
# Hugo docDock theme
|
|
7
|
-
[Hugo-theme-docdock {{%icon fa-github%}}](https://github.com/vjeantet/hugo-theme-docdock) is a theme for Hugo, a fast and modern static website engine written in Go. Hugo is often used for blogs, **this theme is fully designed for documentation.**
|
|
8
|
-
|
|
9
|
-
This theme is a partial porting of the [Learn theme of matcornic {{%icon fa-github%}}](https://github.com/matcornic/hugo-theme-learn). and its default style "flex" comes from [facette.io](https://github.com/facette)'s documentation.
|
|
10
|
-
|
|
11
|
-
{{%panel%}}docDock works with a "page tree structure" to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "content-organisation/_index.md"%}}) {{%/panel%}}
|
|
12
|
-
|
|
13
|
-
## Main features
|
|
14
|
-
|
|
15
|
-
* [Automatic Search]({{%relref "search/_index.md" %}})
|
|
16
|
-
* **Unlimited menu levels**
|
|
17
|
-
* [Generate RevealJS presentation]({{%relref "page-slide.md"%}}) from markdown (embededed or fullscreen page)
|
|
18
|
-
* Automatic next/prev buttons to navigate through menu entries
|
|
19
|
-
* [Image resizing, shadow...]({{%relref "create-page/page-images.md" %}})
|
|
20
|
-
* [Attachments files]({{%relref "shortcodes/attachments.md" %}})
|
|
21
|
-
* [List child pages]({{%relref "shortcodes/children/_index.md" %}})
|
|
22
|
-
* [Excerpt]({{%relref "shortcodes/excerpt.md"%}}) ! Include segment of content from one page in another
|
|
23
|
-
* [Mermaid diagram]({{%relref "shortcodes/mermaid.md" %}}) (flowchart, sequence, gantt)
|
|
24
|
-
* [Icons]({{%relref "shortcodes/icon.md" %}}), [Buttons]({{%relref "shortcodes/button.md" %}}), [Alerts]({{%relref "shortcodes/alert.md" %}}), [Panels]({{%relref "shortcodes/panel.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.md" %}}), [Expand]({{%relref "shortcodes/expand.md" %}})
|
|
25
|
-
* [customizable look and feel]({{%relref "content-organisation/customize-style/_index.md"%}}), [theme style]({{%relref "content-organisation/customize-style/themestyle.md"%}}), [theme variants]({{%relref "content-organisation/customize-style/theme-variants.md"%}})
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
Style "Flex" (default)
|
|
30
|
-
|
|
31
|
-

|
|
32
|
-
|
|
33
|
-
Style "Original"
|
|
34
|
-
|
|
35
|
-

|
|
36
|
-
|
|
37
|
-
## Contribute to this documentation
|
|
38
|
-
Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it
|
|
39
|
-
{{%alert%}}Your modification will be deployed automatically when merged.{{%/alert%}}
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
## Documentation website
|
|
43
|
-
This current documentation has been statically generated with Hugo with a simple command : `hugo -t docdock` -- source code is [available here at GitHub {{%icon fa-github%}}](https://github.com/vjeantet/hugo-theme-docDock)
|
|
44
|
-
|
|
45
|
-
{{% panel theme="success" header="Automated deployments" footer="Netlify builds, deploys, and hosts frontends." %}}
|
|
46
|
-
Automatically published and hosted thanks to [Netlify](https://www.netlify.com/).
|
|
47
|
-
|
|
48
|
-
Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)
|
|
49
|
-
{{% /panel %}}
|
|
50
|
-
|
|
@@ -1,138 +0,0 @@
|
|
|
1
|
-
+++
|
|
2
|
-
title = "Content Organisation"
|
|
3
|
-
description = ""
|
|
4
|
-
weight = 20
|
|
5
|
-
+++
|
|
6
|
-
|
|
7
|
-
With **Hugo**, pages are the core of your site. Organize your site like any other Hugo project. **Magic occurs with the nested sections implemention done in v0.22 of hugo (congrats @bep)**.
|
|
8
|
-
|
|
9
|
-
With docdock, **Each content page composes the menu**, they shape the structure of your website.
|
|
10
|
-
|
|
11
|
-
To link pages to each other, place them in a folders hierarchy
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
content
|
|
15
|
-
├── level-one
|
|
16
|
-
│ ├── level-two
|
|
17
|
-
│ │ ├── level-three
|
|
18
|
-
│ │ │ ├── level-four
|
|
19
|
-
│ │ │ │ ├── _index.md
|
|
20
|
-
│ │ │ │ ├── page-4-a.md
|
|
21
|
-
│ │ │ │ ├── page-4-b.md
|
|
22
|
-
│ │ │ │ └── page-4-c.md
|
|
23
|
-
│ │ │ ├── _index.md
|
|
24
|
-
│ │ │ ├── page-3-a.md
|
|
25
|
-
│ │ │ ├── page-3-b.md
|
|
26
|
-
│ │ │ └── page-3-c.md
|
|
27
|
-
│ │ ├── _index.md
|
|
28
|
-
│ │ ├── page-2-a.md
|
|
29
|
-
│ │ ├── page-2-b.md
|
|
30
|
-
│ │ └── page-2-c.md
|
|
31
|
-
│ ├── _index.md
|
|
32
|
-
│ ├── page-1-a.md
|
|
33
|
-
│ ├── page-1-b.md
|
|
34
|
-
│ └── page-1-c.md
|
|
35
|
-
├── _index.md
|
|
36
|
-
└── page-top.md
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
{{%alert info %}} **_index.md** is required in each folder, it's your "folder home page"{{%/alert%}}
|
|
41
|
-
|
|
42
|
-
### Add header to a menu entry
|
|
43
|
-
|
|
44
|
-
in the page frontmatter, add a `head` param to insert any HTML code before the menu entry:
|
|
45
|
-
|
|
46
|
-
example to display a "Hello"
|
|
47
|
-
|
|
48
|
-
+++
|
|
49
|
-
title = "Github repo"
|
|
50
|
-
head ="<label>Hello</label> "
|
|
51
|
-
+++
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
### Add icon to a menu entry
|
|
56
|
-
|
|
57
|
-
in the page frontmatter, add a `pre` param to insert any HTML code before the menu label:
|
|
58
|
-
|
|
59
|
-
example to display a github icon
|
|
60
|
-
|
|
61
|
-
+++
|
|
62
|
-
title = "Github repo"
|
|
63
|
-
pre ="<i class='fa fa-github'></i> "
|
|
64
|
-
+++
|
|
65
|
-
|
|
66
|
-

|
|
67
|
-
|
|
68
|
-
<!-- ### Customize menu entry label
|
|
69
|
-
|
|
70
|
-
Add a `name` param next to `[menu.main]`
|
|
71
|
-
|
|
72
|
-
+++
|
|
73
|
-
[menu.main]
|
|
74
|
-
parent = ""
|
|
75
|
-
identifier = "repo"
|
|
76
|
-
pre ="<i class='fa fa-github'></i> "
|
|
77
|
-
name = "Github repo"
|
|
78
|
-
+++ -->
|
|
79
|
-
|
|
80
|
-
<!-- ### Create a page redirector
|
|
81
|
-
Add a `url` param next to `[menu.main]`
|
|
82
|
-
|
|
83
|
-
+++
|
|
84
|
-
[menu.main]
|
|
85
|
-
parent = "page"
|
|
86
|
-
identifier = "page-images"
|
|
87
|
-
weight = 23
|
|
88
|
-
url = "/shortcode/image/"
|
|
89
|
-
+++
|
|
90
|
-
|
|
91
|
-
{{%alert info%}}Look at the menu "Create Page/About images" which redirects to "Shortcodes/image{{%/alert%}}
|
|
92
|
-
-->
|
|
93
|
-
### Order sibling menu/page entries
|
|
94
|
-
|
|
95
|
-
in your frontmatter add `weight` param with a number to order.
|
|
96
|
-
|
|
97
|
-
+++
|
|
98
|
-
title="My page"
|
|
99
|
-
weight = 4
|
|
100
|
-
+++
|
|
101
|
-
|
|
102
|
-
{{%info%}}add `ordersectionsby = "title"` in your config.toml to order menu entries by title{{%/info%}}
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
### Hide a menu entry
|
|
106
|
-
|
|
107
|
-
in your frontmatter add `hidden=true` param.
|
|
108
|
-
|
|
109
|
-
+++
|
|
110
|
-
title="My page"
|
|
111
|
-
hidden = true
|
|
112
|
-
+++
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
### Unfolded menu entry by default
|
|
116
|
-
|
|
117
|
-
One or more menuentries can be displayed unfolded by default. (like the "Getting start" menu entry in this website)
|
|
118
|
-
|
|
119
|
-
in your frontmatter add `alwaysopen=true` param.
|
|
120
|
-
example :
|
|
121
|
-
|
|
122
|
-
```
|
|
123
|
-
title = "Getting start"
|
|
124
|
-
description = ""
|
|
125
|
-
weight = 1
|
|
126
|
-
alwaysopen = true
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
### Folder structure and file name
|
|
130
|
-
|
|
131
|
-
Content organization **is** your `content` folder structure.
|
|
132
|
-
|
|
133
|
-
### Homepage
|
|
134
|
-
|
|
135
|
-
Find out how to [customize homepage]({{%relref "homepage.md"%}})
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/_index.md
DELETED
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
+++
|
|
2
|
-
title = "Customize website look and feel"
|
|
3
|
-
Weight=3
|
|
4
|
-
+++
|
|
5
|
-
|
|
6
|
-
You can change the style and behavior of the theme without touching it.
|
|
7
|
-
|
|
8
|
-
* inject your own html, css or js into the page
|
|
9
|
-
* overide existing css or js with your own files
|
|
10
|
-
|
|
11
|
-
{{%notice note %}}
|
|
12
|
-
No needs to copy the entire theme to customize some parts
|
|
13
|
-
Bellow are solutions to avoid copying the entire theme into your own codebase.
|
|
14
|
-
{{%/notice%}}
|
|
15
|
-
|
|
16
|
-
## Add custom CSS and JS or HTML into the \<head\> part of each page :
|
|
17
|
-
|
|
18
|
-
Create a custom header partial `layouts/partials/custom-head.html`
|
|
19
|
-
|
|
20
|
-
> * content/
|
|
21
|
-
> * layouts/
|
|
22
|
-
> * partials/
|
|
23
|
-
> * custom-head.html
|
|
24
|
-
|
|
25
|
-
write your own content like (an example from @nzbart):
|
|
26
|
-
```html
|
|
27
|
-
<link rel="stylesheet" href="/css/custom.css">
|
|
28
|
-
<script src="/js/custom.js"></script>
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Then overrode the style your want to change in `static/css/custom.css` (in this case, to avoid altering the casing of titles):
|
|
32
|
-
```css
|
|
33
|
-
h2 {
|
|
34
|
-
text-transform: none;
|
|
35
|
-
}
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
And executed some additional JavaScript from `static/js/custom.js` (note that jQuery is already loaded by the theme):
|
|
39
|
-
```javascript
|
|
40
|
-
function tweakPage() {
|
|
41
|
-
// make some changes here
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
$(tweakPage)
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
now feel free to add the JS, CSS, HTML code you want :)
|
|
49
|
-
|
|
50
|
-
## Add custom HTML at the end of the body part of each page :
|
|
51
|
-
|
|
52
|
-
Create a `custom-footer.html` into a `layouts/partials` folder next to the content folder
|
|
53
|
-
|
|
54
|
-
> * content/
|
|
55
|
-
> * layouts/
|
|
56
|
-
> * partials/
|
|
57
|
-
> * custom-footer.html
|
|
58
|
-
|
|
59
|
-
now feel free to add the JS, CSS, HTML code you want :)
|
|
60
|
-
|
|
61
|
-
## Overide existing CSS or JS
|
|
62
|
-
|
|
63
|
-
Create the matching file in your static folder, hugo will use yours instead of the theme's one.
|
|
64
|
-
Example :
|
|
65
|
-
|
|
66
|
-
create a theme.css and place it into `static/css/` to fully overide docdock's theme.css
|
package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/disable.md
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
+++
|
|
2
|
-
title = "Disable features"
|
|
3
|
-
+++
|
|
4
|
-
|
|
5
|
-
You can disable feature in docdock by changing some params in `config.toml`
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
## hide Next / Prev Chevrons
|
|
9
|
-
```
|
|
10
|
-
[params]
|
|
11
|
-
disableNavChevron = true
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
## hide Search box in side menu
|
|
15
|
-
```
|
|
16
|
-
[params]
|
|
17
|
-
disableSearch = true
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
## hide the {{%icon fa-home%}} icon in side bar
|
|
21
|
-
```
|
|
22
|
-
[params]
|
|
23
|
-
disableHomeIcon = true
|
|
24
|
-
```
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
+++
|
|
2
|
-
title = "Theme variants"
|
|
3
|
-
description = "change theme style/colors"
|
|
4
|
-
+++
|
|
5
|
-
|
|
6
|
-
In site configuration file, you can set a variant name of this theme to load a specific css, with different color specifications.
|
|
7
|
-
|
|
8
|
-
add a param `themeVariant = "VARIANT_NAME"` in the `[params]` part of config.toml file.
|
|
9
|
-
|
|
10
|
-
{{%info%}}Available variants change only colors at this moment{{%/info%}}
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
## Variant "gray"
|
|
14
|
-
```
|
|
15
|
-
[params]
|
|
16
|
-
themeVariant = "gray"
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-

|
|
20
|
-
|
|
21
|
-
## Variant "gold"
|
|
22
|
-
```
|
|
23
|
-
[params]
|
|
24
|
-
themeVariant = "gold"
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-

|
|
28
|
-
|
|
29
|
-
## Variant "green"
|
|
30
|
-
```
|
|
31
|
-
[params]
|
|
32
|
-
themeVariant = "green"`
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-

|
package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/themestyle.md
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
+++
|
|
2
|
-
title = "Theme styles"
|
|
3
|
-
description = "change theme style"
|
|
4
|
-
+++
|
|
5
|
-
|
|
6
|
-
In site configuration file, you can set a subtheme name of this theme to load a specific css.
|
|
7
|
-
|
|
8
|
-
add a param `themeStyle = "STYLE_NAME"` in the `[params]` part of config.toml file.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
## Style "original"
|
|
12
|
-
```
|
|
13
|
-
[params]
|
|
14
|
-
themeStyle = "original"
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-

|
|
18
|
-
|
|
19
|
-
## Style "flex" (work in progress)
|
|
20
|
-
```
|
|
21
|
-
[params]
|
|
22
|
-
themeStyle = "flex"
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-

|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
+++
|
|
2
|
-
title = "Extra menu entries"
|
|
3
|
-
date = "2017-04-29T18:36:24+02:00"
|
|
4
|
-
Weight=2
|
|
5
|
-
+++
|
|
6
|
-
|
|
7
|
-
You can define additional menu entries in the navigation menu without any link to content.
|
|
8
|
-
|
|
9
|
-
Edit the website configuration `config.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add.
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
Example from the current website, **note the `pre` param** which allows you to insert HTML code and used here to separate content's menu from this "static" menu
|
|
13
|
-
|
|
14
|
-
[[menu.shortcuts]]
|
|
15
|
-
pre = "<h3>More</h3>"
|
|
16
|
-
name = "<i class='fa fa-github'></i> Github repo"
|
|
17
|
-
identifier = "ds"
|
|
18
|
-
url = "https://github.com/vjeantet/hugo-theme-docdock"
|
|
19
|
-
weight = 1
|
|
20
|
-
|
|
21
|
-
[[menu.shortcuts]]
|
|
22
|
-
name = "<i class='fa fa-bookmark'></i> Hugo Documentation"
|
|
23
|
-
identifier = "hugodoc"
|
|
24
|
-
url = "https://gohugo.io/"
|
|
25
|
-
weight = 2
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
[{{%icon circle-arrow-right%}} Read more about hugo and menu here](https://gohugo.io/extras/menus/)
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
+++
|
|
2
|
-
title = "Logo placeholder"
|
|
3
|
-
description = ""
|
|
4
|
-
date = "2017-04-24T18:36:24+02:00"
|
|
5
|
-
Weight=1
|
|
6
|
-
+++
|
|
7
|
-
|
|
8
|
-
Create a `_header.md` page in content folder. Its content is what you get in the logo placeholder (top left of the screen).
|
|
9
|
-
|
|
10
|
-
{{%alert info%}}**Tip :** you can add a image, a combobox with links to other documentation....{{%/alert%}}
|
|
11
|
-
|
|
12
|
-
{{%alert info%}}**Tip 2 :** look at [ extra static menu]({{%relref "extramenu.md"%}}) if you want to add links to other website in this sidebar{{%/alert%}}
|