├── website ├── .hugo_build.lock ├── themes │ └── docsy │ │ ├── .hugo_build.lock │ │ ├── layouts │ │ ├── partials │ │ │ ├── hooks │ │ │ │ ├── footer-end.html │ │ │ │ ├── body-end.html │ │ │ │ └── head-end.html │ │ │ ├── reading-time.html │ │ │ ├── toc.html │ │ │ ├── page-meta-lastmod.html │ │ │ ├── navbar-version-selector.html │ │ │ ├── pager.html │ │ │ ├── navbar-lang-selector.html │ │ │ ├── sidebar.html │ │ │ ├── head-css.html │ │ │ ├── featured-image.html │ │ │ ├── breadcrumb.html │ │ │ ├── version-banner.html │ │ │ ├── disqus-comment.html │ │ │ ├── favicons.html │ │ │ ├── community_links.html │ │ │ ├── section-index.html │ │ │ ├── search-input.html │ │ │ ├── head.html │ │ │ ├── scripts.html │ │ │ ├── footer.html │ │ │ ├── navbar.html │ │ │ ├── feedback.html │ │ │ └── page-meta-links.html │ │ ├── blog │ │ │ ├── single.html │ │ │ ├── content.html │ │ │ ├── baseof.html │ │ │ └── list.html │ │ ├── docs │ │ │ ├── single.html │ │ │ ├── list.html │ │ │ └── baseof.html │ │ ├── swagger │ │ │ ├── single.html │ │ │ ├── list.html │ │ │ └── baseof.html │ │ ├── home.html │ │ ├── _default │ │ │ ├── list.html │ │ │ ├── single.html │ │ │ ├── baseof.html │ │ │ ├── search.html │ │ │ ├── content.html │ │ │ └── list.rss.xml │ │ ├── shortcodes │ │ │ ├── pageinfo.html │ │ │ ├── alert.html │ │ │ ├── readfile.md │ │ │ ├── blocks │ │ │ │ ├── link-down.html │ │ │ │ ├── section.html │ │ │ │ ├── feature.html │ │ │ │ ├── lead.html │ │ │ │ └── cover.html │ │ │ ├── swaggerui.html │ │ │ └── imgproc.html │ │ ├── 404.html │ │ └── community │ │ │ └── list.html │ │ ├── .gitignore │ │ ├── userguide │ │ ├── .gitignore │ │ ├── content │ │ │ └── en │ │ │ │ ├── search.md │ │ │ │ ├── featured-background.jpg │ │ │ │ ├── about │ │ │ │ └── featured-background.jpg │ │ │ │ ├── docs │ │ │ │ ├── Adding content │ │ │ │ │ ├── Shortcodes │ │ │ │ │ │ └── spruce.jpg │ │ │ │ │ └── _index.md │ │ │ │ ├── Best practices │ │ │ │ │ └── _index.md │ │ │ │ ├── Examples │ │ │ │ │ └── _index.md │ │ │ │ └── Updating │ │ │ │ │ └── _index.md │ │ │ │ ├── community │ │ │ │ └── _index.md │ │ │ │ └── _index.html │ │ ├── static │ │ │ ├── google6a6ae8b5b016a20d.html │ │ │ └── images │ │ │ │ ├── no.png │ │ │ │ ├── yes.png │ │ │ │ ├── feedback.png │ │ │ │ └── version-banner.png │ │ ├── .gitmodules │ │ ├── assets │ │ │ └── scss │ │ │ │ └── _variables_project.scss │ │ ├── package.json │ │ ├── deploy.sh │ │ ├── layouts │ │ │ └── sitemap.xml │ │ └── CONTRIBUTING.md │ │ ├── .prettierrc.json │ │ ├── images │ │ ├── tn.png │ │ └── screenshot.png │ │ ├── assets │ │ ├── icons │ │ │ └── logo.png │ │ ├── scss │ │ │ ├── _breadcrumb.scss │ │ │ ├── blocks │ │ │ │ ├── _blocks.scss │ │ │ │ └── _cover.scss │ │ │ ├── _styles_project.scss │ │ │ ├── _variables_project.scss │ │ │ ├── _blog.scss │ │ │ ├── _buttons.scss │ │ │ ├── section-index.scss │ │ │ ├── _pageinfo.scss │ │ │ ├── _alerts.scss │ │ │ ├── support │ │ │ │ ├── _functions.scss │ │ │ │ ├── _mixins.scss │ │ │ │ └── _utilities.scss │ │ │ ├── _search.scss │ │ │ ├── _main-container.scss │ │ │ ├── _code.scss │ │ │ ├── _sidebar-toc.scss │ │ │ ├── _colors.scss │ │ │ ├── main.scss │ │ │ ├── _content.scss │ │ │ └── _nav.scss │ │ ├── json │ │ │ └── offline-search-index.json │ │ ├── stubs │ │ │ └── new-page-template.md │ │ └── js │ │ │ ├── search.js │ │ │ ├── mermaid.js │ │ │ ├── base.js │ │ │ └── anchor.js │ │ ├── static │ │ ├── favicons │ │ │ ├── favicon.ico │ │ │ ├── tile70x70.png │ │ │ ├── favicon-1024.png │ │ │ ├── favicon-256.png │ │ │ ├── pwa-192x192.png │ │ │ ├── pwa-512x512.png │ │ │ ├── tile150x150.png │ │ │ ├── tile310x150.png │ │ │ ├── tile310x310.png │ │ │ ├── android-36x36.png │ │ │ ├── android-48x48.png │ │ │ ├── android-72x72.png │ │ │ ├── android-96x96.png │ │ │ ├── favicon-16x16.png │ │ │ ├── favicon-32x32.png │ │ │ ├── android-144x144.png │ │ │ ├── android-192x192.png │ │ │ └── apple-touch-icon-180x180.png │ │ └── webfonts │ │ │ ├── fa-solid-900.eot │ │ │ ├── fa-solid-900.ttf │ │ │ ├── fa-brands-400.eot │ │ │ ├── fa-brands-400.ttf │ │ │ ├── fa-brands-400.woff │ │ │ ├── fa-regular-400.eot │ │ │ ├── fa-regular-400.ttf │ │ │ ├── fa-solid-900.woff │ │ │ ├── fa-solid-900.woff2 │ │ │ ├── fa-brands-400.woff2 │ │ │ ├── fa-regular-400.woff │ │ │ └── fa-regular-400.woff2 │ │ ├── .editorconfig │ │ ├── theme.toml │ │ ├── .s3deploy.yml │ │ ├── netlify.toml │ │ ├── config.toml │ │ ├── postcss.config.js │ │ ├── i18n │ │ ├── zh.toml │ │ ├── ko.toml │ │ ├── ja.toml │ │ ├── en.toml │ │ ├── no.toml │ │ ├── it.toml │ │ ├── de.toml │ │ ├── ru.toml │ │ ├── pt-br.toml │ │ ├── es.toml │ │ ├── fr.toml │ │ └── hu.toml │ │ └── CONTRIBUTING.md ├── layouts │ ├── _default │ │ ├── single.html │ │ ├── _markup │ │ │ └── render-link.html │ │ ├── search.html │ │ ├── list.html │ │ ├── content.html │ │ └── baseof.html │ ├── 404.html │ ├── partials │ │ ├── toc.html │ │ ├── favicons.html │ │ ├── navbar-lang-selector.html │ │ ├── page-meta-lastmod.html │ │ ├── twitter_cards.html │ │ ├── featured-image.html │ │ ├── section-index.html │ │ ├── navbar.html │ │ ├── page-meta-links.html │ │ ├── head.html │ │ ├── feedback.html │ │ └── search-input.html │ ├── home.html │ └── shortcodes │ │ └── blocks │ │ ├── section.html │ │ ├── feature.html │ │ └── lead.html ├── content │ ├── de │ │ ├── search.md │ │ └── about │ │ │ └── _index.md │ └── en │ │ ├── search.md │ │ └── about │ │ └── _index.md ├── netlify.toml ├── static │ ├── images │ │ ├── .DS_Store │ │ ├── cnmm-share.jpg │ │ ├── man-at-conference.jpg │ │ └── woman-at-conference.jpg │ ├── favicons │ │ ├── favicon.ico │ │ ├── apple-touch-icon.png │ │ ├── android-chrome-192x192.png │ │ ├── android-chrome-512x512.png │ │ └── favicon.svg │ ├── fonts │ │ ├── ClarityCity-100.ttf │ │ ├── ClarityCity-200.ttf │ │ ├── ClarityCity-300.ttf │ │ ├── ClarityCity-400.ttf │ │ ├── ClarityCity-500.ttf │ │ ├── ClarityCity-600.ttf │ │ ├── ClarityCity-700.ttf │ │ ├── ClarityCity-800.ttf │ │ ├── ClarityCity-900.ttf │ │ ├── ClarityCity-100.woff │ │ ├── ClarityCity-100.woff2 │ │ ├── ClarityCity-200.woff │ │ ├── ClarityCity-200.woff2 │ │ ├── ClarityCity-300.woff │ │ ├── ClarityCity-300.woff2 │ │ ├── ClarityCity-400.woff │ │ ├── ClarityCity-400.woff2 │ │ ├── ClarityCity-500.woff │ │ ├── ClarityCity-500.woff2 │ │ ├── ClarityCity-600.woff │ │ ├── ClarityCity-600.woff2 │ │ ├── ClarityCity-700.woff │ │ ├── ClarityCity-700.woff2 │ │ ├── ClarityCity-800.woff │ │ ├── ClarityCity-800.woff2 │ │ ├── ClarityCity-900.woff │ │ ├── ClarityCity-900.woff2 │ │ ├── ClarityCity-100Italic.ttf │ │ ├── ClarityCity-100Italic.woff │ │ ├── ClarityCity-100Italic.woff2 │ │ ├── ClarityCity-200Italic.ttf │ │ ├── ClarityCity-200Italic.woff │ │ ├── ClarityCity-200Italic.woff2 │ │ ├── ClarityCity-300Italic.ttf │ │ ├── ClarityCity-300Italic.woff │ │ ├── ClarityCity-300Italic.woff2 │ │ ├── ClarityCity-400Italic.ttf │ │ ├── ClarityCity-400Italic.woff │ │ ├── ClarityCity-400Italic.woff2 │ │ ├── ClarityCity-500Italic.ttf │ │ ├── ClarityCity-500Italic.woff │ │ ├── ClarityCity-500Italic.woff2 │ │ ├── ClarityCity-600Italic.ttf │ │ ├── ClarityCity-600Italic.woff │ │ ├── ClarityCity-600Italic.woff2 │ │ ├── ClarityCity-700Italic.ttf │ │ ├── ClarityCity-700Italic.woff │ │ ├── ClarityCity-700Italic.woff2 │ │ ├── ClarityCity-800Italic.ttf │ │ ├── ClarityCity-800Italic.woff │ │ ├── ClarityCity-800Italic.woff2 │ │ ├── ClarityCity-900Italic.ttf │ │ ├── ClarityCity-900Italic.woff │ │ └── ClarityCity-900Italic.woff2 │ ├── social │ │ ├── boxed-flickr.svg │ │ ├── flickr.svg │ │ ├── boxed-stack-overflow.svg │ │ ├── boxed-twitch.svg │ │ ├── boxed-email.svg │ │ ├── boxed-facebook.svg │ │ ├── boxed-instagram.svg │ │ ├── boxed-youtube.svg │ │ ├── boxed-linkedin.svg │ │ ├── linkedin-black.svg │ │ ├── linkedin-white.svg │ │ ├── email.svg │ │ ├── boxed-twitter.svg │ │ ├── boxed-meetup.svg │ │ ├── boxed-discussion.svg │ │ ├── boxed-rss.svg │ │ ├── boxed-blog.svg │ │ ├── boxed-github.svg │ │ ├── boxed-slack.svg │ │ ├── boxed-whatsapp.svg │ │ ├── facebook.svg │ │ ├── youtube.svg │ │ ├── boxed-wechat.svg │ │ ├── boxed-qq.svg │ │ ├── twitter.svg │ │ ├── github.svg │ │ ├── boxed-website.svg │ │ ├── slack.svg │ │ ├── wechat.svg │ │ ├── boxed-gitter.svg │ │ ├── boxed-lf-devstats.svg │ │ ├── twitch.svg │ │ ├── instagram.svg │ │ └── boxed-lf-artwork.svg │ └── js │ │ └── home.js ├── Dockerfile ├── docker-compose.yaml ├── i18n │ ├── de.toml │ └── en.toml ├── assets │ └── scss │ │ ├── _archive.scss │ │ ├── _reset.scss │ │ ├── _styles_project.scss │ │ ├── _projects.scss │ │ ├── _buttons.scss │ │ ├── _taxonomy.scss │ │ ├── _video.scss │ │ ├── _about.scss │ │ ├── _typography.scss │ │ ├── _sidebar-toc.scss │ │ ├── _main.scss │ │ ├── _search.scss │ │ └── _hamburger.scss └── package.json ├── .gitignore ├── OWNERS ├── .gitmodules └── .github └── settings.yml /website/.hugo_build.lock: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/.hugo_build.lock: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/hooks/footer-end.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | website/resources 3 | public/ 4 | go.local.mod 5 | go.sum 6 | .DS_Store -------------------------------------------------------------------------------- /website/layouts/_default/single.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ .Render "content" }} 3 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/.gitignore: -------------------------------------------------------------------------------- 1 | 2 | public/ 3 | resources/ 4 | node_modules/ 5 | tech-doc-hugo 6 | 7 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/blog/single.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ .Render "content" }} 3 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/layouts/docs/single.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ .Render "content" }} 3 | {{ end }} -------------------------------------------------------------------------------- /website/content/de/search.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Suchergebnisse 3 | layout: search 4 | toc_hide: true 5 | --- 6 | 7 | -------------------------------------------------------------------------------- /website/content/en/search.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Search Results 3 | layout: search 4 | toc_hide: true 5 | --- 6 | 7 | -------------------------------------------------------------------------------- /website/netlify.toml: -------------------------------------------------------------------------------- 1 | [build] 2 | [build.environment] 3 | HUGO_VERSION = "0.104.3" 4 | GO_VERSION = "1.19.2" 5 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/swagger/single.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ .Render "content" }} 3 | {{ end }} -------------------------------------------------------------------------------- /website/static/images/.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/images/.DS_Store -------------------------------------------------------------------------------- /website/themes/docsy/userguide/.gitignore: -------------------------------------------------------------------------------- 1 | 2 | public/ 3 | resources/ 4 | node_modules/ 5 | tech-doc-hugo 6 | 7 | -------------------------------------------------------------------------------- /website/themes/docsy/userguide/content/en/search.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Search Results 3 | layout: search 4 | --- 5 | 6 | -------------------------------------------------------------------------------- /website/static/favicons/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/favicons/favicon.ico -------------------------------------------------------------------------------- /website/themes/docsy/.prettierrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "semi": true, 3 | "singleQuote": true, 4 | "tabWidth": 4 5 | } 6 | -------------------------------------------------------------------------------- /website/themes/docsy/images/tn.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/images/tn.png -------------------------------------------------------------------------------- /website/themes/docsy/layouts/home.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ with .Content }} 3 | {{ . }} 4 | {{ end }} 5 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/userguide/static/google6a6ae8b5b016a20d.html: -------------------------------------------------------------------------------- 1 | google-site-verification: google6a6ae8b5b016a20d.html 2 | -------------------------------------------------------------------------------- /website/static/images/cnmm-share.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/images/cnmm-share.jpg -------------------------------------------------------------------------------- /website/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM klakegg/hugo:ext-alpine 2 | 3 | RUN apk add git && \ 4 | git config --global --add safe.directory /src 5 | -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-100.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-100.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-200.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-200.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-300.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-300.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-400.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-400.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-500.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-500.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-600.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-600.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-700.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-700.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-800.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-800.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-900.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-900.ttf -------------------------------------------------------------------------------- /website/themes/docsy/layouts/_default/list.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ with .Content }} 3 | {{ . }} 4 | {{ end }} 5 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/layouts/_default/single.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ with .Content }} 3 | {{ . }} 4 | {{ end }} 5 | {{ end }} -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-100.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-100.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-100.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-100.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-200.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-200.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-200.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-200.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-300.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-300.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-300.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-300.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-400.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-400.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-400.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-400.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-500.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-500.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-500.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-500.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-600.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-600.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-600.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-600.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-700.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-700.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-700.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-700.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-800.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-800.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-800.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-800.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-900.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-900.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-900.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-900.woff2 -------------------------------------------------------------------------------- /website/static/images/man-at-conference.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/images/man-at-conference.jpg -------------------------------------------------------------------------------- /website/themes/docsy/assets/icons/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/assets/icons/logo.png -------------------------------------------------------------------------------- /website/themes/docsy/images/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/images/screenshot.png -------------------------------------------------------------------------------- /website/static/favicons/apple-touch-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/favicons/apple-touch-icon.png -------------------------------------------------------------------------------- /website/static/images/woman-at-conference.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/images/woman-at-conference.jpg -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-100Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-100Italic.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-100Italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-100Italic.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-100Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-100Italic.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-200Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-200Italic.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-200Italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-200Italic.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-200Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-200Italic.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-300Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-300Italic.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-300Italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-300Italic.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-300Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-300Italic.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-400Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-400Italic.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-400Italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-400Italic.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-400Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-400Italic.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-500Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-500Italic.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-500Italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-500Italic.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-500Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-500Italic.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-600Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-600Italic.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-600Italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-600Italic.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-600Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-600Italic.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-700Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-700Italic.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-700Italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-700Italic.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-700Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-700Italic.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-800Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-800Italic.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-800Italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-800Italic.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-800Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-800Italic.woff2 -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-900Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-900Italic.ttf -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-900Italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-900Italic.woff -------------------------------------------------------------------------------- /website/static/fonts/ClarityCity-900Italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/fonts/ClarityCity-900Italic.woff2 -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/favicon.ico -------------------------------------------------------------------------------- /website/themes/docsy/userguide/.gitmodules: -------------------------------------------------------------------------------- 1 | 2 | [submodule "themes/docsy"] 3 | path = themes/docsy 4 | url = https://github.com/google/docsy 5 | -------------------------------------------------------------------------------- /website/static/favicons/android-chrome-192x192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/favicons/android-chrome-192x192.png -------------------------------------------------------------------------------- /website/static/favicons/android-chrome-512x512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/static/favicons/android-chrome-512x512.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/tile70x70.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/tile70x70.png -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_breadcrumb.scss: -------------------------------------------------------------------------------- 1 | // Breadcrumb 2 | 3 | .breadcrumb { 4 | background: none; 5 | padding-left: 0; 6 | padding-top: 0; 7 | } -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/hooks/body-end.html: -------------------------------------------------------------------------------- 1 | {{ with .Site.Params.algolia_docsearch }} 2 | 3 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/hooks/head-end.html: -------------------------------------------------------------------------------- 1 | {{ with .Site.Params.algolia_docsearch }} 2 | 3 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/favicon-1024.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/favicon-1024.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/favicon-256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/favicon-256.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/pwa-192x192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/pwa-192x192.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/pwa-512x512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/pwa-512x512.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/tile150x150.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/tile150x150.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/tile310x150.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/tile310x150.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/tile310x310.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/tile310x310.png -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-solid-900.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-solid-900.eot -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-solid-900.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-solid-900.ttf -------------------------------------------------------------------------------- /website/themes/docsy/userguide/static/images/no.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/userguide/static/images/no.png -------------------------------------------------------------------------------- /website/themes/docsy/userguide/static/images/yes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/userguide/static/images/yes.png -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/blocks/_blocks.scss: -------------------------------------------------------------------------------- 1 | @import "cover"; 2 | 3 | .td-bg-arrow { 4 | &-wrapper { 5 | position: relative; 6 | } 7 | } -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/reading-time.html: -------------------------------------------------------------------------------- 1 |

{{ .ReadingTime }} minute read

-------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/android-36x36.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/android-36x36.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/android-48x48.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/android-48x48.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/android-72x72.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/android-72x72.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/android-96x96.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/android-96x96.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/favicon-16x16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/favicon-16x16.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/favicon-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/favicon-32x32.png -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-brands-400.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-brands-400.eot -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-brands-400.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-brands-400.ttf -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-brands-400.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-brands-400.woff -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-regular-400.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-regular-400.eot -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-regular-400.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-regular-400.ttf -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-solid-900.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-solid-900.woff -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-solid-900.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-solid-900.woff2 -------------------------------------------------------------------------------- /OWNERS: -------------------------------------------------------------------------------- 1 | maintainers: 2 | - siforster 3 | - daniellemcook 4 | - Deep-Cyber 5 | - robertglenn 6 | 7 | reviewers: 8 | - CathPag 9 | - JasonMorgan 10 | -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/android-144x144.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/android-144x144.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/android-192x192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/android-192x192.png -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-brands-400.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-brands-400.woff2 -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-regular-400.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-regular-400.woff -------------------------------------------------------------------------------- /website/themes/docsy/static/webfonts/fa-regular-400.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/webfonts/fa-regular-400.woff2 -------------------------------------------------------------------------------- /website/themes/docsy/userguide/assets/scss/_variables_project.scss: -------------------------------------------------------------------------------- 1 | /* 2 | Add styles or override variables from the theme here. 3 | */ 4 | 5 | $secondary: #D95040; 6 | -------------------------------------------------------------------------------- /website/themes/docsy/userguide/static/images/feedback.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/userguide/static/images/feedback.png -------------------------------------------------------------------------------- /website/themes/docsy/userguide/static/images/version-banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/userguide/static/images/version-banner.png -------------------------------------------------------------------------------- /website/themes/docsy/static/favicons/apple-touch-icon-180x180.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/static/favicons/apple-touch-icon-180x180.png -------------------------------------------------------------------------------- /website/themes/docsy/userguide/content/en/featured-background.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/userguide/content/en/featured-background.jpg -------------------------------------------------------------------------------- /website/themes/docsy/userguide/content/en/about/featured-background.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/userguide/content/en/about/featured-background.jpg -------------------------------------------------------------------------------- /website/themes/docsy/userguide/content/en/docs/Adding content/Shortcodes/spruce.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/node/cartografos/main/website/themes/docsy/userguide/content/en/docs/Adding content/Shortcodes/spruce.jpg -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_styles_project.scss: -------------------------------------------------------------------------------- 1 | /* 2 | 3 | Nothing defined here. The Hugo project that uses this theme can override Bootstrap by adding a file to: 4 | 5 | assets/scss/_styles_project.scss 6 | 7 | */ 8 | -------------------------------------------------------------------------------- /website/themes/docsy/userguide/content/en/community/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Community 3 | menu: 4 | main: 5 | weight: 40 6 | --- 7 | 8 | 9 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/toc.html: -------------------------------------------------------------------------------- 1 | {{ partial "page-meta-links.html" . }} 2 | {{ if not .Params.notoc }} 3 | {{ with .TableOfContents }} 4 | {{ if ge (len .) 200 }} 5 | {{ . }} 6 | {{ end }} 7 | {{ end }} 8 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/layouts/shortcodes/pageinfo.html: -------------------------------------------------------------------------------- 1 | {{ $_hugo_config := `{ "version": 1 }` }} 2 | {{ $color := .Get "color" | default "primary" }} 3 |
4 | {{ .Inner }} 5 |
6 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_variables_project.scss: -------------------------------------------------------------------------------- 1 | /* 2 | 3 | Nothing defined here. The Hugo project that uses this theme can override theme variables by adding a file to: 4 | 5 | assets/scss/_variables_project.scss 6 | 7 | */ 8 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_blog.scss: -------------------------------------------------------------------------------- 1 | // Blog related styles. 2 | 3 | .td-blog { 4 | .td-rss-button { 5 | position: absolute; 6 | top: 5.5rem; 7 | right: 1rem; 8 | z-index: 22; 9 | } 10 | } -------------------------------------------------------------------------------- /website/static/social/boxed-flickr.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/.editorconfig: -------------------------------------------------------------------------------- 1 | # Editor configuration, see https://editorconfig.org 2 | 3 | root = true 4 | 5 | # All files 6 | [*] 7 | charset = utf-8 8 | end_of_line = lf 9 | insert_final_newline = true 10 | trim_trailing_whitespace = true 11 | -------------------------------------------------------------------------------- /website/themes/docsy/userguide/content/en/docs/Adding content/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Content and Customization" 3 | linkTitle: "Content and Customization" 4 | weight: 3 5 | description: > 6 | How to add content to and customize your Docsy site. 7 | --- 8 | -------------------------------------------------------------------------------- /website/docker-compose.yaml: -------------------------------------------------------------------------------- 1 | version: "3.3" 2 | 3 | services: 4 | 5 | site: 6 | image: docsy/docsy-example 7 | build: 8 | context: . 9 | command: server 10 | ports: 11 | - "1313:1313" 12 | volumes: 13 | - .:/src 14 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/page-meta-lastmod.html: -------------------------------------------------------------------------------- 1 | {{ T "post_last_mod"}} {{ .Lastmod.Format .Site.Params.time_format_default }}{{ with .GitInfo }}: {{ .Subject }} ({{ .AbbreviatedHash }}){{end }} 2 | -------------------------------------------------------------------------------- /website/layouts/404.html: -------------------------------------------------------------------------------- 1 | {{ define "main"}} 2 |
3 |
4 |

Not found

5 |

Oops! This page doesn't exist. Try going back to our home page.

6 |
7 |
8 | {{ end }} 9 | -------------------------------------------------------------------------------- /website/i18n/de.toml: -------------------------------------------------------------------------------- 1 | # UI strings. Buttons and similar. 2 | 3 | # Footer text 4 | [footer_all_rights_reserved] 5 | other = " | Dokumentation unter CC-BY-4.0 verbreitet" 6 | 7 | [post_create_issue] 8 | other = "Problem melden" 9 | 10 | [page_contents] 11 | other = "Seiten Inhalt" 12 | 13 | -------------------------------------------------------------------------------- /website/i18n/en.toml: -------------------------------------------------------------------------------- 1 | # UI strings. Buttons and similar. 2 | 3 | # Footer text 4 | [footer_all_rights_reserved] 5 | other = " | Documentation Distributed under CC-BY-4.0" 6 | 7 | [post_create_issue] 8 | other = "Create issue" 9 | 10 | [page_contents] 11 | other = "Page Contents" 12 | 13 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/404.html: -------------------------------------------------------------------------------- 1 | {{ define "main"}} 2 |
3 |
4 |

Not found

5 |

Oops! This page doesn't exist. Try going back to our home page.

6 |
7 |
8 | {{ end }} 9 | -------------------------------------------------------------------------------- /website/layouts/partials/toc.html: -------------------------------------------------------------------------------- 1 | {{ partial "page-meta-links.html" . }} 2 | 3 | {{ if not .Params.notoc }} 4 | {{ with .TableOfContents }} 5 | {{ if ge (len .) 200 }} 6 |
{{ T "page_contents" }}
7 | {{ . }} 8 | {{ end }} 9 | {{ end }} 10 | {{ end }} 11 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_buttons.scss: -------------------------------------------------------------------------------- 1 | // Buttons 2 | 3 | @if $enable-rounded { 4 | .btn { 5 | border-radius: 1rem; 6 | 7 | &-lg { 8 | border-radius: 2rem; 9 | } 10 | 11 | &-sm { 12 | border-radius: 1rem; 13 | } 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /website/static/social/flickr.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/shortcodes/alert.html: -------------------------------------------------------------------------------- 1 | {{ $_hugo_config := `{ "version": 1 }` }} 2 | {{ $color := .Get "color" | default "primary" }} 3 | 7 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/section-index.scss: -------------------------------------------------------------------------------- 1 | .section-index { 2 | 3 | .entry { 4 | padding: .75rem; 5 | } 6 | 7 | h5 { 8 | margin-bottom: 0; 9 | 10 | a { 11 | font-weight: 700; 12 | } 13 | } 14 | 15 | p { 16 | margin-top: 0; 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /website/assets/scss/_archive.scss: -------------------------------------------------------------------------------- 1 | .article-teaser { 2 | h3 { 3 | margin-top: 34px; 4 | a { 5 | color: $black; 6 | } 7 | } 8 | } 9 | 10 | .articles-of-tag hr { 11 | background: linear-gradient(180deg, #c4c4c4, hsla(0, 0%, 77%, 0)); 12 | border-bottom: 0; 13 | height: 10px; 14 | opacity: 0.15; 15 | width: 100%; 16 | } 17 | -------------------------------------------------------------------------------- /website/assets/scss/_reset.scss: -------------------------------------------------------------------------------- 1 | figure { 2 | -webkit-margin-before: 0; 3 | margin-block-start: 0; 4 | -webkit-margin-after: 0; 5 | margin-block-end: 0; 6 | -webkit-margin-start: 0; 7 | -moz-margin-start: 0; 8 | margin-inline-start: 0; 9 | -webkit-margin-end: 0; 10 | -moz-margin-end: 0; 11 | margin-inline-end: 0; 12 | } 13 | -------------------------------------------------------------------------------- /website/layouts/partials/favicons.html: -------------------------------------------------------------------------------- 1 | 2 | 5 | 8 | 10 | -------------------------------------------------------------------------------- /website/static/social/boxed-stack-overflow.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/shortcodes/readfile.md: -------------------------------------------------------------------------------- 1 | {{$file := .Get "file"}} 2 | {{- if eq (.Get "markdown") "true" -}} 3 | {{- $file | readFile | markdownify -}} 4 | {{- else if (.Get "highlight") -}} 5 | {{- highlight ($file | readFile) (.Get "highlight") "" -}} 6 | {{- else -}} 7 | {{ $file | readFile | safeHTML }} 8 | {{- end -}} 9 | -------------------------------------------------------------------------------- /website/static/social/boxed-twitch.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "website/themes/docsy/assets/vendor/bootstrap"] 2 | path = website/themes/docsy/assets/vendor/bootstrap 3 | url = https://github.com/twbs/bootstrap.git 4 | [submodule "website/themes/docsy/assets/vendor/Font-Awesome"] 5 | path = website/themes/docsy/assets/vendor/Font-Awesome 6 | url = https://github.com/FortAwesome/Font-Awesome.git 7 | -------------------------------------------------------------------------------- /website/static/social/boxed-email.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/userguide/content/en/docs/Best practices/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Best Practices" 3 | weight: 9 4 | description: > 5 | Optional guidance and recommendations about organizing, authoring, and managing your technical documentation. 6 | --- 7 | 8 | Use this section to learn about some of the best practices around creating technical documentation with Docsy. 9 | -------------------------------------------------------------------------------- /website/static/social/boxed-facebook.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/static/social/boxed-instagram.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/static/social/boxed-youtube.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/static/social/boxed-linkedin.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/static/social/linkedin-black.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/static/social/linkedin-white.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/static/social/email.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/shortcodes/blocks/link-down.html: -------------------------------------------------------------------------------- 1 | {{ with .Parent }} 2 | {{ $id := $.Get "id" | default (printf "td-block-%d" ( add .Ordinal 1 )) }} 3 | {{ $color := $.Get "color" | default "blue" }} 4 | 5 | {{ else }} 6 | {{ errorf "The link-down shortcode is supposed to be nested inside a shortcode"}} 7 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/navbar-version-selector.html: -------------------------------------------------------------------------------- 1 | 4 |
5 | {{ range .Site.Params.versions }} 6 | {{ .version }} 7 | {{ end }} 8 |
9 | -------------------------------------------------------------------------------- /website/themes/docsy/theme.toml: -------------------------------------------------------------------------------- 1 | name = "Docsy" 2 | license = "Apache 2.0" 3 | licenselink = "https://github.com/google/docsy/blob/master/LICENSE" 4 | description = "A Hugo theme for technical documentation sites" 5 | homepage = "https://docsy.dev" 6 | tags = ["documentation", "multilingual", "customizable", "responsive", "docs"] 7 | features = [] 8 | min_version = 0.53 9 | 10 | [author] 11 | name = "The Docsy Authors" 12 | homepage = "https://docsy.dev" 13 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_pageinfo.scss: -------------------------------------------------------------------------------- 1 | .pageinfo { 2 | font-weight: $font-weight-medium; 3 | background: $gray-100; 4 | color: inherit; 5 | border-radius: 0; 6 | margin: 2rem; 7 | padding: 1.5rem; 8 | padding-bottom: 0.5rem; 9 | 10 | @each $color, $value in $theme-colors { 11 | &-#{$color} { 12 | 13 | border-style: solid; 14 | border-color: $value; 15 | } 16 | } 17 | 18 | } 19 | -------------------------------------------------------------------------------- /website/static/social/boxed-twitter.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/.s3deploy.yml: -------------------------------------------------------------------------------- 1 | routes: 2 | - route: "^.+\\.(js|css|svg|ttf)$" 3 | # cache static assets for 20 years 4 | headers: 5 | Cache-Control: "max-age=630720000, no-transform, public" 6 | gzip: true 7 | - route: "^.+\\.(png|jpg)$" 8 | headers: 9 | Cache-Control: "max-age=630720000, no-transform, public" 10 | gzip: true 11 | - route: "^.+\\.(html|xml|json)$" 12 | gzip: true 13 | 14 | -------------------------------------------------------------------------------- /website/layouts/home.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | 3 |
4 |

{{ .Title }}

5 | 6 | {{ with .Content }} 7 | {{ . }} 8 | {{ end }} 9 | {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable)) }} 10 | {{ partial "feedback.html" .Site.Params.ui.feedback }} 11 |
12 | {{ end }} 13 |
{{ partial "page-meta-lastmod.html" . }}
14 | 15 |
16 | 17 | {{ end }} -------------------------------------------------------------------------------- /website/static/social/boxed-meetup.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_alerts.scss: -------------------------------------------------------------------------------- 1 | // Style alert boxes. 2 | 3 | .alert { 4 | font-weight: $font-weight-medium; 5 | background: $white; 6 | color: inherit; 7 | border-radius: 0; 8 | 9 | @each $color, $value in $theme-colors { 10 | &-#{$color} { 11 | & .alert-heading { 12 | color: $value; 13 | } 14 | 15 | border-style: solid; 16 | border-color: $value; 17 | border-width: 0 0 0 4px; 18 | } 19 | } 20 | } -------------------------------------------------------------------------------- /website/themes/docsy/netlify.toml: -------------------------------------------------------------------------------- 1 | # Hugo build configuration for Netlify 2 | # (https://gohugo.io/hosting-and-deployment/hosting-on-netlify/#configure-hugo-version-in-netlify) 3 | 4 | # Default build settings 5 | [build] 6 | publish = "userguide/public" 7 | command = "git submodule update -f --init && cd userguide && npm install postcss-cli && hugo --themesDir ../.." 8 | 9 | # "production" environment specific build settings 10 | [build.environment] 11 | HUGO_VERSION = "0.55.6" 12 | HUGO_THEME = "repo" 13 | HUGO_ENV = "production" 14 | -------------------------------------------------------------------------------- /website/static/social/boxed-discussion.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/shortcodes/blocks/section.html: -------------------------------------------------------------------------------- 1 | {{ $_hugo_config := `{ "version": 1 }` }} 2 | {{ $col_id := .Get "color" | default .Ordinal }} 3 | {{ $height := .Get "height" | default "auto" }} 4 | {{ $type := .Get "type" | default "" }} 5 | 6 |
7 |
8 |
9 | {{ .Inner | markdownify}} 10 |
11 |
12 |
13 | -------------------------------------------------------------------------------- /website/layouts/shortcodes/blocks/section.html: -------------------------------------------------------------------------------- 1 | {{ $_hugo_config := `{ "version": 1 }` }} 2 | {{ $col_id := .Get "color" | default .Ordinal }} 3 | {{ $height := .Get "height" | default "auto" }} 4 | {{ $type := .Get "type" | default "" }} 5 | 6 |
7 |
8 |
9 | {{ .Inner | markdownify}} 10 |
11 |
12 |
13 | -------------------------------------------------------------------------------- /website/static/social/boxed-rss.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/pager.html: -------------------------------------------------------------------------------- 1 | 8 | -------------------------------------------------------------------------------- /website/static/social/boxed-blog.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/static/social/boxed-github.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/_default/baseof.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | {{ partial "head.html" . }} 5 | 6 | 7 |
8 | {{ partial "navbar.html" . }} 9 |
10 |
11 |
12 | {{ block "main" . }}{{ end }} 13 |
14 | {{ partial "footer.html" . }} 15 |
16 | {{ partialCached "scripts.html" . }} 17 | 18 | -------------------------------------------------------------------------------- /website/layouts/_default/_markup/render-link.html: -------------------------------------------------------------------------------- 1 | {{ $link := .Destination }} 2 | {{ $isRemote := strings.HasPrefix $link "http" }} 3 | {{- if not $isRemote -}} 4 | {{ $url := urls.Parse .Destination }} 5 | {{- if $url.Path -}} 6 | {{ $fragment := "" }} 7 | {{- with $url.Fragment }}{{ $fragment = printf "#%s" . }}{{ end -}} 8 | {{- with .Page.GetPage $url.Path }}{{ $link = printf "%s%s" .RelPermalink $fragment }}{{ end }}{{ end -}} 9 | {{- end -}} 10 | {{ .Text | safeHTML }} -------------------------------------------------------------------------------- /website/layouts/_default/search.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 |
3 |

{{ .Title }}

4 | {{ with .Site.Params.gcs_engine_id }} 5 | 16 | 17 | {{ end }} 18 |
19 | 20 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/config.toml: -------------------------------------------------------------------------------- 1 | # This the theme configuration for Docsy. 2 | # Allowed configuration in a theme is (currently): 3 | # params (global and per language) 4 | # menu (global and per language) 5 | # outputformats and mediatypes 6 | 7 | [params] 8 | time_format_blog = "Monday, January 02, 2006" 9 | time_format_default = "January 2, 2006" 10 | # Sections to publish in the main RSS feed. 11 | rss_sections = ["blog"] 12 | 13 | 14 | # For a full list of parameters used in Docsy sites, see: 15 | # https://github.com/google/docsy-example/blob/master/config.toml 16 | 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/shortcodes/blocks/feature.html: -------------------------------------------------------------------------------- 1 | {{ $icon := .Get "icon" | default "fa-lightbulb" }} 2 | {{ $url_text := .Get "url_text" }} 3 |
4 |
5 | 6 |
7 |

{{ .Get "title" | markdownify }}

8 |

{{ .Inner }}

9 | {{ with .Get "url" }}

{{ with $url_text }}{{ $url_text }}{{ else }}{{ T "ui_read_more" }}{{ end }} …

{{ end }} 10 |
11 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/shortcodes/blocks/lead.html: -------------------------------------------------------------------------------- 1 | {{ $_hugo_config := `{ "version": 1 }` }} 2 | {{ $col_id := .Get "color" | default .Ordinal }} 3 | {{ $height := .Get "height" | default "auto" }} 4 | {{/* Height can be one of: auto, min, med, max, full. */}} 5 | 6 |
7 |
8 | 9 | {{ .Inner | markdownify }} 10 | 11 |
12 |
13 | -------------------------------------------------------------------------------- /website/static/social/boxed-slack.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/navbar-lang-selector.html: -------------------------------------------------------------------------------- 1 | {{/* Link directly to documentation etc., if possible. */}} 2 | {{ $langPage := cond (gt (len .Translations) 0) . .Site.Home }} 3 | 6 |
7 | {{ range $langPage.Translations }} 8 | {{ .Language.LanguageName }} 9 | {{ end }} 10 |
-------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/sidebar.html: -------------------------------------------------------------------------------- 1 | {{/* The "active" toggle here may delay rendering, so we only cache this side bar menu for bigger sites. */}} 2 | {{ $shouldCache := ge (len .Site.Pages) 2000 }} 3 | {{ if $shouldCache }} 4 | {{ $mid := printf "m-%s" (.RelPermalink | anchorize) }} 5 | 11 | {{ partialCached "sidebar-tree.html" . .CurrentSection.RelPermalink }} 12 | {{ else }} 13 | {{ partial "sidebar-tree.html" . }} 14 | {{ end }} 15 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/blocks/_cover.scss: -------------------------------------------------------------------------------- 1 | // A cover block is a full size cover with a fixed background for smaller screens. 2 | 3 | @include td-box-height-modifiers(".td-cover-block"); 4 | 5 | .td-cover-logo { 6 | margin-right: 0.5em; 7 | } 8 | 9 | .td-cover-block { 10 | position: relative; 11 | padding-top: 5rem; 12 | padding-bottom: 5rem; 13 | background: { 14 | repeat: no-repeat; 15 | position: 50% 0; 16 | size: cover; 17 | }; 18 | 19 | & > .byline { 20 | position: absolute; 21 | bottom: 2px; 22 | right: 4px; 23 | } 24 | } -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/support/_functions.scss: -------------------------------------------------------------------------------- 1 | // Common functions. 2 | 3 | @function prepend($list, $value) { 4 | @return join($value, $list); 5 | } 6 | 7 | 8 | 9 | // See https://www.sitepoint.com/using-sass-build-color-palettes/ 10 | @function color-diff($a, $b) { 11 | $sat: saturation($a) - saturation($b); 12 | $lig: lightness($a) - lightness($b); 13 | $fn-sat: if($sat > 0, 'desaturate', 'saturate'); 14 | $fn-lig: if($lig > 0, 'darken', 'lighten'); 15 | 16 | @return ( 17 | adjust-hue: -(hue($a) - hue($b)), 18 | #{$fn-sat}: abs($sat), 19 | #{$fn-lig}: abs($lig) 20 | ); 21 | } -------------------------------------------------------------------------------- /website/layouts/shortcodes/blocks/feature.html: -------------------------------------------------------------------------------- 1 | {{ $icon := .Get "icon" | default "fa-lightbulb" }} 2 | {{ $url_text := .Get "url_text" }} 3 | 4 |
5 |
6 | 7 |
8 |

{{ .Get "title" | markdownify }}

9 |

{{ .Inner }}

10 | {{ with .Get "url" }}

{{ with $url_text }}{{ $url_text }}{{ else }}{{ T "ui_read_more" }}…{{ end }}

{{ end }} 11 |
12 | -------------------------------------------------------------------------------- /website/assets/scss/_styles_project.scss: -------------------------------------------------------------------------------- 1 | /** 2 | * Project Styles 3 | * 4 | * This theme is used to overide the variables in themes/docsy/assets/scss/_styles_project.scss 5 | * 6 | * It's loaded AFTER all other styles. 7 | * 8 | */ 9 | 10 | @import 'hamburger'; 11 | @import 'reset'; 12 | @import 'archive'; 13 | @import 'buttons'; 14 | @import 'footer'; 15 | @import 'header'; 16 | @import 'main'; 17 | @import 'search'; 18 | @import 'sidebar-left'; 19 | @import 'cookie-banner'; 20 | @import 'sidebar-toc'; 21 | @import 'taxonomy'; 22 | @import 'typography'; 23 | @import 'about'; 24 | @import 'video'; 25 | @import 'projects'; 26 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/json/offline-search-index.json: -------------------------------------------------------------------------------- 1 | {{- $.Scratch.Add "offline-search-index" slice -}} 2 | {{- range where .Site.AllPages ".Params.exclude_search" "!=" true -}} 3 | {{/* We have to apply `htmlUnescape` again after `truncate` because `truncate` applies `html.EscapeString` if the argument is not HTML. */}} 4 | {{- $.Scratch.Add "offline-search-index" (dict "title" .Title "ref" .RelPermalink "body" (.Plain | htmlUnescape) "excerpt" (.Plain | htmlUnescape | truncate (.Site.Params.offlineSearchSummaryLength | default 70) | htmlUnescape)) -}} 5 | {{- end -}} 6 | {{- $.Scratch.Get "offline-search-index" | jsonify -}} 7 | -------------------------------------------------------------------------------- /website/static/social/boxed-whatsapp.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/static/social/facebook.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/static/social/youtube.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/assets/scss/_projects.scss: -------------------------------------------------------------------------------- 1 | // project social links 2 | ul.project-links { 3 | list-style-type: none; 4 | padding-left: 0; 5 | margin-top: 1rem; 6 | margin-bottom: 4rem; 7 | @media (min-width: 1000px) { 8 | margin-bottom: 4rem; 9 | } 10 | display: flex; 11 | flex-wrap: wrap; 12 | max-width: 100% !important; 13 | li { 14 | margin-bottom: 1em; 15 | &:not(:last-child) { 16 | margin-right: 1em; 17 | } 18 | } 19 | 20 | img { 21 | color: #000; 22 | height: 32px; 23 | width: auto; 24 | margin-right: 1em; 25 | } 26 | } 27 | 28 | img.project-logo { 29 | max-height: 110px; 30 | max-width: 110px; 31 | width: 100%; 32 | height: auto; 33 | margin: 0; 34 | } 35 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/_default/search.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 |
3 |
4 |

{{ .Title }}

5 | {{ with .Site.Params.gcs_engine_id }} 6 | 17 | 18 | {{ end }} 19 |
20 |
21 | 22 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/head-css.html: -------------------------------------------------------------------------------- 1 | 2 | {{ $scssMain := "scss/main.scss"}} 3 | {{ if .Site.IsServer }} 4 | {{/* Note the missing postCSS. This makes it snappier to develop in Chrome, but makes it look sub-optimal in other browsers. */}} 5 | {{ $css := resources.Get $scssMain | toCSS (dict "enableSourceMap" true) }} 6 | 7 | {{ else }} 8 | {{ $css := resources.Get $scssMain | toCSS (dict "enableSourceMap" false) | postCSS | minify | fingerprint }} 9 | 10 | 11 | {{ end }} 12 | -------------------------------------------------------------------------------- /website/layouts/partials/navbar-lang-selector.html: -------------------------------------------------------------------------------- 1 | {{/* Link directly to documentation etc., if possible. */}} 2 | {{ $langPage := cond (gt (len .Translations) 0) . .Site.Home }} 3 | 7 |
9 | {{ range $langPage.Translations }} 10 | 11 | {{ .Language.LanguageName }} 12 | {{ end }} 13 |
14 | 15 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/featured-image.html: -------------------------------------------------------------------------------- 1 | {{ $w := .w | default 480 }} 2 | {{ $h := .h | default 180 }} 3 | {{ $p := .p }} 4 | {{ $class := .class | default "ml-3" }} 5 | {{ $image := ($p.Resources.ByType "image").GetMatch "**featured*" }} 6 | {{ with $image }} 7 | {{ $image := .Fill (printf "%dx%d" $w $h ) }} 8 |
9 | Featured Image for {{ $p.Title }} 10 | {{ with $image.Params.byline }} 11 |
{{ . | html }}
12 | {{ end }} 13 |
14 | {{ end }} -------------------------------------------------------------------------------- /website/layouts/shortcodes/blocks/lead.html: -------------------------------------------------------------------------------- 1 | {{ $_hugo_config := `{ "version": 1 }` }} 2 | {{ $col_id := .Get "color" | default .Ordinal }} 3 | {{ $height := .Get "height" | default "auto" }} 4 | {{ $align := .Get "align" | default "center" }} 5 | {{/* Height can be one of: auto, min, med, max, full. */}} 6 | {{/* Align can be one of: center, left, right. */}} 7 | 8 |
9 |
10 | 11 | {{ .Inner | markdownify }} 12 | 13 |
14 |
15 | -------------------------------------------------------------------------------- /website/static/social/boxed-wechat.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/swagger/list.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 |
3 |

{{ .Title }}

4 | {{ with .Params.description }}
{{ . | markdownify }}
{{ end }} 5 | {{ .Content }} 6 | {{ partial "section-index.html" . }} 7 | {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) }} 8 | {{ partial "feedback.html" .Site.Params.ui.feedback }} 9 |
10 | {{ end }} 11 | {{ if (.Site.DisqusShortname) }} 12 |
13 | {{ partial "disqus-comment.html" . }} 14 | {{ end }} 15 |
{{ partial "page-meta-lastmod.html" . }}
16 |
17 | {{ end }} 18 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/community/list.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | 3 | 4 |
5 |
6 | 7 |

Join the {{ .Site.Title }} community

8 | 9 |

{{ .Site.Title }} is an open source project that anyone in the community can use, improve, and enjoy. We'd love you to join us! Here's a few ways to find out what's happening and get involved. 10 | 11 |

12 |
13 | {{ partial "community_links.html" . }} 14 | 15 |
16 | {{ .Content }} 17 |
18 | 19 | {{ end }} 20 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/shortcodes/swaggerui.html: -------------------------------------------------------------------------------- 1 | {{ $original := .Get "src" }} 2 |
3 | -------------------------------------------------------------------------------- /website/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tech-doc-hugo", 3 | "version": "0.0.1", 4 | "description": "Hugo theme for technical documentation.", 5 | "main": "none.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/google/docsy-example.git" 12 | }, 13 | "author": "", 14 | "license": "ISC", 15 | "bugs": { 16 | "url": "https://github.com/google/docsy-example/issues" 17 | }, 18 | "homepage": "https://github.com/google/docsy-example#readme", 19 | "devDependencies": { 20 | "autoprefixer": "^10.4.0", 21 | "postcss": "^8.3.7", 22 | "postcss-cli": "^9.0.2" 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /website/static/social/boxed-qq.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/layouts/partials/page-meta-lastmod.html: -------------------------------------------------------------------------------- 1 | {{ $path := "" }} 2 | {{ with .File }} 3 | {{ $path = .Path }} 4 | {{ else }} 5 | {{ $path = .Path }} 6 | {{ end }} 7 | {{ $pathFormatted := replace $path "\\" "/" }} 8 | {{- $prefix := index (split $path "/") 0 -}} 9 | {{- $github := index ($.Site.Param "github") $prefix -}} 10 | {{ if not $github }}{{- $github = ($.Site.Param "github") -}}{{ end }} 11 | {{ if $github }} 12 | {{ $gh_repo := index $github "repo" }} 13 | {{ if isset .Params "lastmod" }} 14 | {{ T "post_last_mod"}} {{ .Lastmod.Format .Site.Params.time_format_default }}{{ with .GitInfo }}: {{ .Subject }} ({{ .AbbreviatedHash }}){{end }} 15 | {{ end }} 16 | {{ end }} 17 | -------------------------------------------------------------------------------- /website/themes/docsy/userguide/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tech-doc-hugo", 3 | "version": "0.0.1", 4 | "description": "Hugo theme for technical documentation.", 5 | "main": "none.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/bep/tech-doc-hugo.git" 12 | }, 13 | "author": "", 14 | "license": "ISC", 15 | "bugs": { 16 | "url": "https://github.com/bep/tech-doc-hugo/issues" 17 | }, 18 | "homepage": "https://github.com/bep/tech-doc-hugo#readme", 19 | "dependencies": {}, 20 | "devDependencies": { 21 | "autoprefixer": "^9.5.0", 22 | "postcss-cli": "^5.0.1" 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/stubs/new-page-template.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Long Page Title" 3 | linkTitle: "Short Nav Title" 4 | weight: 100 5 | description: >- 6 | Page description for heading and indexes. 7 | --- 8 | 9 | ## Heading 10 | 11 | Edit this template to create your new page. 12 | 13 | * Give it a good name, ending in `.md` - e.g. `getting-started.md` 14 | * Edit the "front matter" section at the top of the page (weight controls how its ordered amongst other pages in the same directory; lowest number first). 15 | * Add a good commit message at the bottom of the page (<80 characters; use the extended description field for more detail). 16 | * Create a new branch so you can preview your new file and request a review via Pull Request. 17 | -------------------------------------------------------------------------------- /website/themes/docsy/postcss.config.js: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright 2018 Google LLC 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | https://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | module.exports = { 18 | plugins: { 19 | autoprefixer: {} 20 | }, 21 | } 22 | -------------------------------------------------------------------------------- /website/layouts/_default/list.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 |
3 |

{{ .Title }}

4 | {{ with .Params.description }}
{{ . | markdownify }}
{{ end }} 5 | {{ if (and (not .Params.hide_readingtime) (.Site.Params.ui.readingtime.enable)) }} 6 | {{ partial "reading-time.html" . }} 7 | {{ end }} 8 | {{ .Content }} 9 | {{ partial "section-index.html" . }} 10 | {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) }} 11 | {{ partial "feedback.html" .Site.Params.ui.feedback }} 12 |
13 | {{ end }} 14 |
{{ partial "page-meta-lastmod.html" . }}
15 |
16 | {{ end }} 17 | -------------------------------------------------------------------------------- /website/layouts/_default/content.html: -------------------------------------------------------------------------------- 1 |
2 |

{{ .Title }}

3 | {{ with .Params.description }}
{{ . | markdownify }}
{{ end }} 4 | {{ if (and (not .Params.hide_readingtime) (.Site.Params.ui.readingtime.enable)) }} 5 | {{ partial "reading-time.html" . }} 6 | {{ end }} 7 | {{ .Content }} 8 | {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable)) }} 9 | {{ partial "feedback.html" .Site.Params.ui.feedback }} 10 |
11 | {{ end }} 12 | {{ if (.Site.Params.DisqusShortname) }} 13 |
14 | {{ partial "disqus-comment.html" . }} 15 | {{ end }} 16 |
{{ partial "page-meta-lastmod.html" . }}
17 |
18 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_search.scss: -------------------------------------------------------------------------------- 1 | // Search 2 | 3 | .td-search-input { 4 | background: transparent; 5 | max-width: 90%; 6 | 7 | &.form-control:focus { 8 | border-color: lighten($primary, 60%); 9 | box-shadow: 0 0 0 2px lighten($primary, 30%); 10 | } 11 | 12 | @if $enable-rounded { 13 | border-radius: 1rem; 14 | } 15 | 16 | font-family: "Font Awesome 5 Free", $font-family-base; 17 | } 18 | 19 | .popover.offline-search-result { 20 | // Override bootstrap default style (max-width: $popover-max-width;) 21 | max-width: 90%; 22 | 23 | .card { 24 | margin-bottom: $spacer * .5; 25 | 26 | .card-header { 27 | font-weight: bold; 28 | } 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/breadcrumb.html: -------------------------------------------------------------------------------- 1 | 6 | {{ define "breadcrumbnav" }} 7 | {{ if .p1.Parent }} 8 | {{ if not .p1.Parent.IsHome }} 9 | {{ template "breadcrumbnav" (dict "p1" .p1.Parent "p2" .p2 ) }} 10 | {{ end }} 11 | {{ else if not .p1.IsHome }} 12 | {{ template "breadcrumbnav" (dict "p1" .p1.Site.Home "p2" .p2 ) }} 13 | {{ end }} 14 | {{ $isActive := eq .p1 .p2 }} 15 |
  • 16 | {{ .p1.LinkTitle }} 17 |
    • 18 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/layouts/_default/content.html: -------------------------------------------------------------------------------- 1 |
    2 |

    {{ .Title }}

    3 | {{ with .Params.description }}
    {{ . | markdownify }}
    {{ end }} 4 | {{ if (and (not .Params.hide_readingtime) (.Site.Params.ui.readingtime.enable)) }} 5 | {{ partial "reading-time.html" . }} 6 | {{ end }} 7 | {{ .Content }} 8 | {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) }} 9 | {{ partial "feedback.html" .Site.Params.ui.feedback }} 10 |
    11 | {{ end }} 12 | {{ if (.Site.Params.DisqusShortname) }} 13 |
    14 | {{ partial "disqus-comment.html" . }} 15 | {{ end }} 16 |
    {{ partial "page-meta-lastmod.html" . }}
    17 |
    18 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_main-container.scss: -------------------------------------------------------------------------------- 1 | // The outer page container i.e. common styles for any page. 2 | .td-outer { 3 | display: flex; 4 | flex-direction: column; 5 | height: 100vh; 6 | } 7 | 8 | // The outer page container for the default base template. 9 | .td-default { 10 | main { 11 | section:first-of-type { 12 | @include media-breakpoint-up(md) { 13 | padding-top: 8rem; 14 | } 15 | } 16 | 17 | section { 18 | @extend .td-block-padding; 19 | } 20 | } 21 | } 22 | 23 | .td-main { 24 | flex-grow: 1; 25 | 26 | main { 27 | @include media-breakpoint-up(md) { 28 | padding-top: 5.5rem; 29 | } 30 | 31 | 32 | padding-bottom: 2rem; 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/blog/content.html: -------------------------------------------------------------------------------- 1 |
    2 |

    {{ .Title }}

    3 | {{ with .Params.description }}
    {{ . | markdownify }}
    {{ end }} 4 |
    5 | {{ with .Params.author }}{{ T "post_byline_by" }} {{ . | markdownify }} |{{ end}} 6 | 7 |
    8 | {{ if (and (not .Params.hide_readingtime) (.Site.Params.ui.readingtime.enable)) }} 9 | {{ partial "reading-time.html" . }} 10 | {{ end }} 11 | {{ .Content }} 12 | {{ if (.Site.Params.DisqusShortname) }} 13 |
    14 | {{ partial "disqus-comment.html" . }} 15 |
    16 | {{ end }} 17 | 18 | {{ partial "pager.html" . }} 19 |
    20 | -------------------------------------------------------------------------------- /website/themes/docsy/userguide/deploy.sh: -------------------------------------------------------------------------------- 1 | #Copyright 2018 Google LLC 2 | # 3 | #Licensed under the Apache License, Version 2.0 (the "License"); 4 | #you may not use this file except in compliance with the License. 5 | #You may obtain a copy of the License at 6 | # 7 | # https://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | #Unless required by applicable law or agreed to in writing, software 10 | #distributed under the License is distributed on an "AS IS" BASIS, 11 | #WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | #See the License for the specific language governing permissions and 13 | #limitations under the License. 14 | # 15 | rm -rf public/ 16 | HUGO_ENV="production" hugo --gc || exit 1 17 | s3deploy -source=public/ -region=eu-west-1 -bucket=bep.is -distribution-id=E8OKNT7W9ZYZ2 -path temp/td 18 | -------------------------------------------------------------------------------- /website/static/social/twitter.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/static/favicons/favicon.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/assets/scss/_buttons.scss: -------------------------------------------------------------------------------- 1 | // buttons. 2 | .button-reset { 3 | background: none; 4 | border: none; 5 | box-sizing: border-box; 6 | cursor: pointer; 7 | display: block; 8 | margin-left: 0; 9 | margin-right: 0; 10 | padding: 0; 11 | width: unset; 12 | } 13 | 14 | .cncf-button { 15 | color: $white; 16 | background-color: $black; 17 | border: 0; 18 | border-radius: 3px; 19 | box-shadow: none; 20 | box-sizing: border-box; 21 | cursor: pointer; 22 | font-size: 16px; 23 | font-weight: 700; 24 | letter-spacing: 0.02em; 25 | line-height: 105%; 26 | margin: 0; 27 | max-width: 100%; 28 | padding: 12px 40px; 29 | text-align: center; 30 | text-decoration: none; 31 | text-transform: uppercase; 32 | transition: all 0.25s ease-out; 33 | word-break: break-word; 34 | &:hover { 35 | background-color: $gray-700; 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/version-banner.html: -------------------------------------------------------------------------------- 1 | 3 | {{ if .Site.Params.archived_version }} 4 | {{ $color := "primary" }} 5 | {{ $latest_version := .Site.Params.url_latest_version }} 6 | {{ $current_version := .Site.Params.version }} 7 |
    8 | {{ with $current_version }}

    Version {{ . | markdownify }} of the 9 | documentation is no longer actively maintained. The site that you are 10 | currently viewing is an archived snapshot. 11 | {{ with $latest_version }}For up-to-date documentation, see the 12 | latest version.

    13 | {{ end }} 14 | {{ end }} 15 |
    16 | {{ end }} 17 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/docs/list.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 |
    3 |

    {{ .Title }}

    4 | {{ with .Params.description }}
    {{ . | markdownify }}
    {{ end }} 5 | {{ if (and (not .Params.hide_readingtime) (.Site.Params.ui.readingtime.enable)) }} 6 | {{ partial "reading-time.html" . }} 7 | {{ end }} 8 | {{ .Content }} 9 | {{ partial "section-index.html" . }} 10 | {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) }} 11 | {{ partial "feedback.html" .Site.Params.ui.feedback }} 12 |
    13 | {{ end }} 14 | {{ if (.Site.DisqusShortname) }} 15 |
    16 | {{ partial "disqus-comment.html" . }} 17 | {{ end }} 18 |
    {{ partial "page-meta-lastmod.html" . }}
    19 |
    20 | {{ end }} 21 | -------------------------------------------------------------------------------- /website/static/js/home.js: -------------------------------------------------------------------------------- 1 | $( document ).ready( 2 | function () { 3 | // Load Slick Slider. 4 | $( '.slider' ).slick( 5 | { 6 | slidesToShow: 1, 7 | slidesToScroll: 1, 8 | autoplay: true, 9 | autoplaySpeed: 7500, 10 | speed: 1500, 11 | arrows: false, 12 | dots: true, 13 | fade: true, 14 | pauseOnHover: false, 15 | infinite: true, 16 | } 17 | ); 18 | 19 | stretchSliderToFitHeight(); 20 | $( window ).resize( 21 | function() { 22 | stretchSliderToFitHeight(); 23 | } 24 | ); 25 | } 26 | ); 27 | 28 | function stretchSliderToFitHeight(){ 29 | let slide = $( '.td-home .frontpage .slider .slide' ); 30 | slide.css( 'min-height', '' ); 31 | let minHeight = $( '.td-main' ).height(); 32 | if ( minHeight > 689 ) { 33 | slide.css( 'min-height', minHeight ); 34 | $( '.slider' ).slick( 'resize' ); 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/zh.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "上一页" 7 | 8 | [ui_pager_next] 9 | other = "下一页" 10 | 11 | [ui_read_more] 12 | other = "更多" 13 | 14 | [ui_search] 15 | other = "站内搜索…" 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "in" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "All Rights Reserved" 24 | 25 | [footer_privacy_policy] 26 | other = "隐私政策" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "By" 32 | [post_created] 33 | other = "创建" 34 | [post_last_mod] 35 | other = "最后修改" 36 | [post_edit_this] 37 | other = "编辑此页" 38 | [post_create_child_page] 39 | other = "添加子页面" 40 | [post_create_issue] 41 | other = "提交文档问题" 42 | [post_create_project_issue] 43 | other = "提交项目问题" 44 | [post_posts_in] 45 | other = "Posts in" 46 | -------------------------------------------------------------------------------- /website/assets/scss/_taxonomy.scss: -------------------------------------------------------------------------------- 1 | // Container for Taxonomy items. 2 | .article-meta { 3 | margin-bottom: 3rem; 4 | } 5 | 6 | .tax-term { 7 | background-color: $link-color; 8 | border-radius: 50px; 9 | font-weight: 500; 10 | font-size: 10px; 11 | line-height: 140%; 12 | text-align: center; 13 | letter-spacing: 0.02em; 14 | color: $white; 15 | padding: 5px 12px; 16 | margin-right: 8px; 17 | &:hover { 18 | color: $white; 19 | text-decoration: none; 20 | background-color: $primary-300; 21 | } 22 | } 23 | 24 | .taxonomy-terms { 25 | list-style: none; 26 | margin: 0; 27 | overflow: hidden; 28 | padding: 0; 29 | display: flex; 30 | flex-wrap: wrap; 31 | } 32 | 33 | .tax-terms { 34 | list-style: none; 35 | margin: 60px 0; 36 | padding: 0; 37 | li { 38 | margin: 20px 0; 39 | } 40 | } 41 | 42 | .taxonomy-count { 43 | padding-left: 0; 44 | margin-left: 0; 45 | } 46 | -------------------------------------------------------------------------------- /website/assets/scss/_video.scss: -------------------------------------------------------------------------------- 1 | // Render the video player as big as possible while retaining the aspect ratio 2 | // https://stackoverflow.com/a/35153397 3 | .video { 4 | position: relative; 5 | width: 100%; 6 | height: 0; 7 | padding-bottom: 56.25%; /* The height of the item will now be 56.25% of the width. */ 8 | margin-bottom: 1em; 9 | 10 | iframe { 11 | position: absolute; 12 | width: 100%; 13 | height: 100%; 14 | left: 0; 15 | top: 0; 16 | } 17 | } 18 | 19 | // Stop the RSS button being absolute. 20 | .td-blog .td-rss-button { 21 | position: static; 22 | top: unset; 23 | right: unset; 24 | z-index: unset; 25 | &:hover { 26 | background-color: $primary-300; 27 | color: $white; 28 | } 29 | } 30 | 31 | // Highlights a set of videos at /videos 32 | .featured { 33 | background-color: $light; 34 | } 35 | 36 | .video-resources a { 37 | font-weight: bold; 38 | } 39 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/ko.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "이전" 7 | 8 | [ui_pager_next] 9 | other = "다음" 10 | 11 | [ui_read_more] 12 | other = "더 읽기" 13 | 14 | [ui_search] 15 | other = "사이트에서 검색…" 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "in" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "All Rights Reserved" 24 | 25 | [footer_privacy_policy] 26 | other = "개인정보 보호 정책" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "By" 32 | [post_created] 33 | other = "작성" 34 | [post_last_mod] 35 | other = "최종 수정" 36 | [post_edit_this] 37 | other = "페이지 편집" 38 | [post_create_child_page] 39 | other = "Create child page" 40 | [post_create_issue] 41 | other = "문서에 이슈 생성" 42 | [post_create_project_issue] 43 | other = "프로젝트에 이슈 생성" 44 | [post_posts_in] 45 | other = "Posts in" 46 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/ja.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "前へ" 7 | 8 | [ui_pager_next] 9 | other = "次へ" 10 | 11 | [ui_read_more] 12 | other = "続きを読む" 13 | 14 | [ui_search] 15 | other = "サイトを検索..." 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "in" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "All Rights Reserved" 24 | 25 | [footer_privacy_policy] 26 | other = "プライバシーポリシー" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "By" 32 | [post_created] 33 | other = "作成" 34 | [post_last_mod] 35 | other = "最終更新" 36 | [post_edit_this] 37 | other = "ページの編集" 38 | [post_create_child_page] 39 | other = "Create child page" 40 | [post_create_issue] 41 | other = "ドキュメントのissueを作成" 42 | [post_create_project_issue] 43 | other = "プロジェクトのissueを作成" 44 | [post_posts_in] 45 | other = "記事一覧" 46 | -------------------------------------------------------------------------------- /website/layouts/partials/twitter_cards.html: -------------------------------------------------------------------------------- 1 | {{ $card := "summary_large_image" }} 2 | {{ with $.Params.youtubeID }} 3 | {{ $card = "player" }} 4 | {{ end }} 5 | 6 | 7 | 8 | 9 | 10 | 11 | {{ if eq $card "player" }} 12 | 13 | 14 | 15 | 16 | {{ else }} 17 | {{ $img := cond (isset $.Params "image") $.Params.image $.Site.Params.image }} 18 | 19 | {{ end }} 20 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/en.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "Previous" 7 | 8 | [ui_pager_next] 9 | other = "Next" 10 | 11 | [ui_read_more] 12 | other = "Read more" 13 | 14 | [ui_search] 15 | other = "Search this site…" 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "in" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "All Rights Reserved" 24 | 25 | [footer_privacy_policy] 26 | other = "Privacy Policy" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "By" 32 | [post_created] 33 | other = "Created" 34 | [post_last_mod] 35 | other = "Last modified" 36 | [post_edit_this] 37 | other = "Edit this page" 38 | [post_create_child_page] 39 | other = "Create child page" 40 | [post_create_issue] 41 | other = "Create documentation issue" 42 | [post_create_project_issue] 43 | other = "Create project issue" 44 | [post_posts_in] 45 | other = "Posts in" 46 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/no.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "Forrige" 7 | 8 | [ui_pager_next] 9 | other = "Neste" 10 | 11 | [ui_read_more] 12 | other = "Les mer" 13 | 14 | [ui_search] 15 | other = "Søk på nettstedet…" 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "i" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "Alle retter er reservert" 24 | 25 | [footer_privacy_policy] 26 | other = "Privacy Policy" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "Av" 32 | [post_created] 33 | other = "Opprettet" 34 | [post_last_mod] 35 | other = "Sist endret" 36 | [post_edit_this] 37 | other = "Endre denne siden" 38 | [post_create_child_page] 39 | other = "Create child page" 40 | [post_create_issue] 41 | other = "Opprett dokumentasjon sak" 42 | [post_create_project_issue] 43 | other = "Opprett prosjekt sak" 44 | [post_posts_in] 45 | other = "Poster i" 46 | -------------------------------------------------------------------------------- /website/static/social/github.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/it.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "Precedente" 7 | 8 | [ui_pager_next] 9 | other = "Successivo" 10 | 11 | [ui_read_more] 12 | other = "Leggi tutto" 13 | 14 | [ui_search] 15 | other = "Cerca nel sito…" 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "in" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "Tutti i diritti riservati" 24 | 25 | [footer_privacy_policy] 26 | other = "Privacy Policy" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "Di" 32 | [post_created] 33 | other = "Creato" 34 | [post_last_mod] 35 | other = "Ultima modifica" 36 | [post_edit_this] 37 | other = "Modifica" 38 | [post_create_child_page] 39 | other = "Create child page" 40 | [post_create_issue] 41 | other = "Crea issue di documentazione" 42 | [post_create_project_issue] 43 | other = "Crea issue di progetto" 44 | [post_posts_in] 45 | other = "Post in" 46 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/de.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "Weiter" 7 | 8 | [ui_pager_next] 9 | other = "Zurück" 10 | 11 | [ui_read_more] 12 | other = "Weiterlesen" 13 | 14 | [ui_search] 15 | other = "Diese Seite durchsuchen…" 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "in" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "Alle Rechte vorbehalten" 24 | 25 | [footer_privacy_policy] 26 | other = "Datenschutzrichtlinie" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "Von" 32 | [post_created] 33 | other = "Erstellt" 34 | [post_last_mod] 35 | other = "Zuletzt geändert" 36 | [post_edit_this] 37 | other = "Diese Seite bearbeiten" 38 | [post_create_child_page] 39 | other = "Create child page" 40 | [post_create_issue] 41 | other = "Problem zu dieser Seite melden" 42 | [post_create_project_issue] 43 | other = "Problem melden" 44 | [post_posts_in] 45 | other = "Einträge in" 46 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/ru.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "Предыдущая" 7 | 8 | [ui_pager_next] 9 | other = "Следующая" 10 | 11 | [ui_read_more] 12 | other = "Подробнее" 13 | 14 | [ui_search] 15 | other = "Поиск по сайту…" 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "в" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "Все права защищены" 24 | 25 | [footer_privacy_policy] 26 | other = "Политика конфиденциальности" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "Автор" 32 | [post_created] 33 | other = "Создано" 34 | [post_last_mod] 35 | other = "Изменено" 36 | [post_edit_this] 37 | other = "Отредактировать страницу" 38 | [post_create_child_page] 39 | other = "Create child page" 40 | [post_create_issue] 41 | other = "Предложить изменения документации" 42 | [post_create_project_issue] 43 | other = "Предложить доработки по проекту" 44 | [post_posts_in] 45 | other = "Публикации в" 46 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/pt-br.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "Anterior" 7 | 8 | [ui_pager_next] 9 | other = "Próximo" 10 | 11 | [ui_read_more] 12 | other = "Ler mais" 13 | 14 | [ui_search] 15 | other = "Buscar no site…" 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "em" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "Todos os direitos reservados" 24 | 25 | [footer_privacy_policy] 26 | other = "Política de Privacidade" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "Por" 32 | [post_created] 33 | other = "Criado" 34 | [post_last_mod] 35 | other = "Última modificação" 36 | [post_edit_this] 37 | other = "Editar essa página" 38 | [post_create_child_page] 39 | other = "Create child page" 40 | [post_create_issue] 41 | other = "Relatar um problema de documentação" 42 | [post_create_project_issue] 43 | other = "Relatar um problema no projeto" 44 | [post_posts_in] 45 | other = "Posts em" 46 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/es.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Botones y similares. 4 | 5 | [ui_pager_prev] 6 | other = "Previo" 7 | 8 | [ui_pager_next] 9 | other = "Siguiente" 10 | 11 | [ui_read_more] 12 | other = "Contiuar leyendo" 13 | 14 | [ui_search] 15 | other = "Buscar" 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "en" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "Derechos reservados" 24 | 25 | [footer_privacy_policy] 26 | other = "Política de privacidad" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "Por" 32 | [post_created] 33 | other = "Creado" 34 | [post_last_mod] 35 | other = "Última modificación" 36 | [post_edit_this] 37 | other = "Editar esta página" 38 | [post_create_child_page] 39 | other = "Create child page" 40 | [post_create_issue] 41 | other = "Notificar una incidencia con la documentanción" 42 | [post_create_project_issue] 43 | other = "Notificar una incidencia en un proyecto" 44 | [post_posts_in] 45 | other = "Añadir entrada" 46 | -------------------------------------------------------------------------------- /website/themes/docsy/i18n/fr.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "Précédent" 7 | 8 | [ui_pager_next] 9 | other = "Suivant" 10 | 11 | [ui_read_more] 12 | other = "Lire plus" 13 | 14 | [ui_search] 15 | other = "Rechercher ce site…" 16 | 17 | # Used in sentences such as "Posted in News" 18 | [ui_in] 19 | other = "dans" 20 | 21 | # Footer text 22 | [footer_all_rights_reserved] 23 | other = "Tous droits résérvés" 24 | 25 | [footer_privacy_policy] 26 | other = "Politique de confidentialité" 27 | 28 | 29 | # Post (blog, articles etc.) 30 | [post_byline_by] 31 | other = "Par" 32 | [post_created] 33 | other = "Crée" 34 | [post_last_mod] 35 | other = "Dernière modification" 36 | [post_edit_this] 37 | other = "Modifier cette page" 38 | [post_create_child_page] 39 | other = "Create child page" 40 | [post_create_issue] 41 | other = "Créer un problème dans la documentation" 42 | [post_create_project_issue] 43 | other = "Créer un problème dans le projet" 44 | [post_posts_in] 45 | other = "Messages dans" 46 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/shortcodes/imgproc.html: -------------------------------------------------------------------------------- 1 | {{ $original := .Page.Resources.GetMatch (printf "**%s*" (.Get 0)) }} 2 | {{ $command := .Get 1 }} 3 | {{ $options := .Get 2 }} 4 | {{ if eq $command "Fit"}} 5 | {{ .Scratch.Set "image" ($original.Fit $options) }} 6 | {{ else if eq $command "Resize"}} 7 | {{ .Scratch.Set "image" ($original.Resize $options) }} 8 | {{ else if eq $command "Fill"}} 9 | {{ .Scratch.Set "image" ($original.Fill $options) }} 10 | {{ else }} 11 | {{ errorf "Invalid image processing command: Must be one of Fit, Fill or Resize."}} 12 | {{ end }} 13 | {{ $image := .Scratch.Get "image" }} 14 |
    15 | 16 | {{ with .Inner }} 17 |
    18 |

    {{ . }}{{ with $image.Params.byline }}
    {{ . | html }}    {{ end }}

    19 |
    20 | {{ end }} 21 |
    -------------------------------------------------------------------------------- /website/themes/docsy/userguide/layouts/sitemap.xml: -------------------------------------------------------------------------------- 1 | {{ printf "" | safeHTML }} 2 | 4 | {{ range .Data.Pages }} 5 | 6 | https://www.docsy.dev{{ .Permalink }}{{ if not .Lastmod.IsZero }} 7 | {{ safeHTML ( .Lastmod.Format "2006-01-02T15:04:05-07:00" ) }}{{ end }}{{ with .Sitemap.ChangeFreq }} 8 | {{ . }}{{ end }}{{ if ge .Sitemap.Priority 0.0 }} 9 | {{ .Sitemap.Priority }}{{ end }}{{ if .IsTranslated }}{{ range .Translations }} 10 | {{ end }} 15 | {{ end }} 20 | 21 | {{ end }} 22 | 23 | -------------------------------------------------------------------------------- /website/static/social/boxed-website.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/disqus-comment.html: -------------------------------------------------------------------------------- 1 |
    2 | 3 |
    4 | 22 | 23 |
    24 | -------------------------------------------------------------------------------- /website/static/social/slack.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/favicons.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /website/assets/scss/_about.scss: -------------------------------------------------------------------------------- 1 | .td-box--primary .td-arrow-down::before { 2 | border: none; 3 | } 4 | 5 | .section-group { 6 | @media (max-width: 767px) { 7 | } 8 | @media (min-width: 768px) { 9 | margin-right: 25px; 10 | section { 11 | padding-left: 25px; 12 | padding-right: 25px; 13 | } 14 | } 15 | } 16 | 17 | .td-box--primary p > a, 18 | .td-box--secondary p > a, 19 | .td-box--light p > a { 20 | color: $link-color; 21 | } 22 | 23 | .td-box--secondary { 24 | background-color: #ffb24c; 25 | color: #464646; 26 | } 27 | 28 | .td-box--primary, 29 | .td-box--white { 30 | background-color: #fdfdfd; 31 | color: $body-color; 32 | 33 | span.lead p { 34 | font-weight: 300; 35 | } 36 | } 37 | 38 | @media (min-width: 768px) { 39 | .td-box--primary h2[id]:before { 40 | margin-top: 0; 41 | height: 0; 42 | } 43 | } 44 | 45 | .td-content > table { 46 | margin-bottom: 2rem; 47 | th { 48 | text-transform: uppercase; 49 | border-top: none; 50 | } 51 | tbody tr:nth-of-type(odd) { 52 | background-color: unset; 53 | } 54 | td { 55 | padding: 1rem; 56 | border-bottom: 1px solid #dee2e6; 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/community_links.html: -------------------------------------------------------------------------------- 1 | {{ $links := .Site.Params.links }} 2 | 3 |
    4 |
    5 |

    Learn and Connect

    6 |

    Using or want to use {{ .Site.Title }}? Find out more here: 7 | {{ with index $links "user"}} 8 | {{ template "community-links-list" . }} 9 | {{ end }} 10 |

    11 |
    12 |

    Develop and Contribute

    13 |

    If you want to get more involved by contributing to {{ .Site.Title }}, join us here: 14 | {{ with index $links "developer"}} 15 | {{ template "community-links-list" . }} 16 | {{ end }} 17 |

    You can find out how to contribute to these docs in our Contribution Guidelines. 18 |

    19 |
    20 | 21 | {{ define "community-links-list" }} 22 | 29 | {{ end }} 30 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/docs/baseof.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | {{ partial "head.html" . }} 5 | 6 | 7 |
    8 | {{ partial "navbar.html" . }} 9 |
    10 |
    11 |
    12 |
    13 |
    14 | {{ partial "sidebar.html" . }} 15 |
    16 |
    17 | {{ partial "toc.html" . }} 18 |
    19 |
    20 | {{ partial "version-banner.html" . }} 21 | {{ if not .Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" . }}{{ end }} 22 | {{ block "main" . }}{{ end }} 23 |
    24 |
    25 |
    26 | {{ partial "footer.html" . }} 27 |
    28 | {{ partial "scripts.html" . }} 29 | 30 | -------------------------------------------------------------------------------- /website/layouts/partials/featured-image.html: -------------------------------------------------------------------------------- 1 | {{ $w := .w | default 480 }} 2 | {{ $h := .h | default 180 }} 3 | {{ $p := .p }} 4 | {{ $class := .class | default "ml-3" }} 5 | {{ $image := ($p.Resources.ByType "image").GetMatch "**featured*" }} 6 | {{ with $image }} 7 | {{ $image := .Fill (printf "%dx%d" $w $h ) }} 8 |
    9 | Featured Image for {{ $p.Title }} 10 | {{ with $image.Params.byline }} 11 |
    {{ . | html }}
    12 | {{ end }} 13 |
    14 | {{ else }} 15 | {{ if $p.Params.youtubeID }} 16 | {{ $image := printf "https://i.ytimg.com/vi/%s/mqdefault.jpg" $p.Params.youtubeID }} 17 |
    18 | Featured Image for {{ $p.Title }} 19 | {{ with $p.Params.byline }} 20 |
    {{ . | html }}
    21 | {{ end }} 22 |
    23 | {{ end }} 24 | {{ end }} -------------------------------------------------------------------------------- /website/themes/docsy/i18n/hu.toml: -------------------------------------------------------------------------------- 1 | 2 | 3 | # UI strings. Buttons and similar. 4 | 5 | [ui_pager_prev] 6 | other = "Előző" 7 | 8 | [ui_pager_next] 9 | other = "Következő" 10 | 11 | [ui_read_more] 12 | other = "További olvasnivaló" 13 | 14 | [ui_search] 15 | other = "Keresés ezen az oldalon…" 16 | 17 | # Used in sentences such as "Posted in News" 18 | # TODO: this structure will not work in Hungarian 19 | # so I left it as is 20 | [ui_in] 21 | other = "in" 22 | 23 | # Footer text 24 | [footer_all_rights_reserved] 25 | other = "Minden jog fenntartva" 26 | 27 | [footer_privacy_policy] 28 | other = "Adatvédelmi szabályzat" 29 | 30 | 31 | # Post (blog, articles etc.) 32 | [post_byline_by] 33 | other = "Készítette" 34 | [post_created] 35 | other = "Elkészítve" 36 | [post_last_mod] 37 | other = "Utolsó módosítás" 38 | [post_edit_this] 39 | other = "Oldal szerkesztése" 40 | [post_create_child_page] 41 | other = "Create child page" 42 | [post_create_issue] 43 | other = "Dokumentáció issue létrehozása" 44 | [post_create_project_issue] 45 | other = "Projekt issue létrehozása" 46 | # TODO: this structure will not work in Hungarian 47 | # so I left it as is 48 | [post_posts_in] 49 | other = "Posts in" 50 | -------------------------------------------------------------------------------- /website/static/social/wechat.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/assets/scss/_typography.scss: -------------------------------------------------------------------------------- 1 | // General Styling. 2 | 3 | // Links 4 | a { 5 | font-weight: 700; 6 | &.tree-root:hover { 7 | color: $primary; 8 | text-decoration: none; 9 | } 10 | } 11 | 12 | h1 { 13 | &.thin { 14 | font-weight: 400; 15 | } 16 | @media (min-width: 768px) { 17 | font-size: 2.5rem; 18 | max-width: 90%; 19 | } 20 | } 21 | 22 | h2 { 23 | @media (max-width: 374px) { 24 | font-size: 1.5rem; 25 | } 26 | &.feedback--title { 27 | margin-top: 5rem; 28 | } 29 | } 30 | 31 | h2, 32 | h3 { 33 | a:hover { 34 | text-decoration: none; 35 | } 36 | } 37 | 38 | // Main page content styling. 39 | .td-content { 40 | > h1 { 41 | margin-bottom: 2.1rem; 42 | } 43 | > h1:not(:first-child) { 44 | margin-top: 3rem; 45 | } 46 | > h2:not(:first-child) { 47 | margin-top: 4rem; 48 | } 49 | > h2 { 50 | margin-bottom: 2.1rem; 51 | } 52 | p { 53 | line-height: 170%; 54 | } 55 | } 56 | 57 | .lead { 58 | font-size: 1.5rem; 59 | } 60 | 61 | // Add some extra padding to large Ps in H4 (see About). 62 | .h4 { 63 | p + p { 64 | margin-top: 20px; 65 | @media (min-width: 1000px) { 66 | margin-top: 30px; 67 | } 68 | } 69 | } 70 | 71 | .fas { 72 | color: #0077e6; 73 | } -------------------------------------------------------------------------------- /website/themes/docsy/layouts/partials/section-index.html: -------------------------------------------------------------------------------- 1 |
    2 | {{ $pages := (where .Site.Pages "Section" .Section).ByWeight }} 3 | {{ $parent := .Page }} 4 | {{ if $parent.Params.no_list }} 5 | {{/* If no_list is true we don't show a list of subpages */}} 6 | {{ else if $parent.Params.simple_list }} 7 | {{/* If simple_list is true we show a bulleted list of subpages */}} 8 | 15 | {{ else }} 16 | {{/* Otherwise we show a nice formatted list of subpages with page descriptions */}} 17 |
    18 | {{ range $pages }} 19 | {{ if eq .Parent $parent }} 20 |
    21 |
    22 | {{- .Title -}} 23 |
    24 |

    {{ .Description | markdownify }}

    25 |
    26 | {{ end }} 27 | {{ end }} 28 | {{ end }} 29 |
    30 | -------------------------------------------------------------------------------- /website/themes/docsy/userguide/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | We'd love to accept your patches and contributions to this project. There are 4 | just a few small guidelines you need to follow. 5 | 6 | ## Contributor License Agreement 7 | 8 | Contributions to this project must be accompanied by a Contributor License 9 | Agreement. You (or your employer) retain the copyright to your contribution; 10 | this simply gives us permission to use and redistribute your contributions as 11 | part of the project. Head over to to see 12 | your current agreements on file or to sign a new one. 13 | 14 | You generally only need to submit a CLA once, so if you've already submitted one 15 | (even if it was for a different project), you probably don't need to do it 16 | again. 17 | 18 | ## Code reviews 19 | 20 | All submissions, including submissions by project members, require review. We 21 | use GitHub pull requests for this purpose. Consult 22 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more 23 | information on using pull requests. 24 | 25 | ## Community Guidelines 26 | 27 | This project follows 28 | [Google's Open Source Community Guidelines](https://opensource.google.com/conduct/). 29 | -------------------------------------------------------------------------------- /website/layouts/_default/baseof.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | {{ partial "head.html" . }} 5 | 6 | 7 |
    8 | {{ partial "navbar.html" . }} 9 |
    10 |
    11 |
    12 |
    13 | 16 | 19 |
    20 | {{ partial "version-banner.html" . }} 21 | {{ if not .Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" . }}{{ end }} 22 | {{ with .Params.Category}}
    {{ upper . }}
    {{ end }} 23 | {{ block "main" . }}{{ end }} 24 |
    25 |
    26 |
    27 | {{ partial "footer.html" . }} 28 |
    29 | {{ partialCached "scripts.html" . }} 30 | 31 | -------------------------------------------------------------------------------- /website/static/social/boxed-gitter.svg: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_code.scss: -------------------------------------------------------------------------------- 1 | // Code formatting. 2 | 3 | .td-content { 4 | // Highlighted code. 5 | .highlight { 6 | @extend .card; 7 | 8 | margin: 2rem 0; 9 | padding: 0; 10 | 11 | pre { 12 | margin: 0; 13 | padding: 1rem; 14 | } 15 | } 16 | 17 | // Inline code 18 | p code, li > code, table code { 19 | color: inherit; 20 | padding: 0.2em 0.4em; 21 | margin: 0; 22 | font-size: 85%; 23 | word-break: normal; 24 | background-color: rgba($black, 0.05); 25 | border-radius: $border-radius; 26 | 27 | br { 28 | display: none; 29 | } 30 | } 31 | 32 | 33 | // Code blocks 34 | pre { 35 | word-wrap: normal; 36 | background-color: $gray-100; 37 | padding: $spacer; 38 | 39 | 40 | > code { 41 | background-color: inherit !important; 42 | padding: 0; 43 | margin: 0; 44 | font-size: 100%; 45 | word-break: normal; 46 | white-space: pre; 47 | border: 0; 48 | } 49 | } 50 | 51 | pre.mermaid { 52 | background-color: inherit; 53 | font-size: 0; 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /website/layouts/partials/section-index.html: -------------------------------------------------------------------------------- 1 |
    2 | {{ $pages := (where .Site.Pages "Section" .Section).ByWeight }} 3 | {{ $parent := .Page }} 4 | {{ if not $parent.Params.list_pages }} 5 | {{/* If list_pages is not true we don't show a list of subpages */}} 6 | {{ else if $parent.Params.simple_list }} 7 | {{/* If simple_list is true we show a bulleted list of subpages */}} 8 | 15 | {{ else }} 16 | {{/* Otherwise we show a nice formatted list of subpages with page descriptions */}} 17 |
    18 |

    Pages in this section:

    19 | {{ range $pages }} 20 | {{ if eq .Parent $parent }} 21 |
    22 |
    23 | {{- .Title -}} 24 |
    25 |

    {{ .Description | markdownify }}

    26 |
    27 | {{ end }} 28 | {{ end }} 29 | {{ end }} 30 |
    31 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_sidebar-toc.scss: -------------------------------------------------------------------------------- 1 | // 2 | // Right side toc 3 | // 4 | .td-toc { 5 | border-left: 1px solid $border-color; 6 | 7 | @supports (position: sticky) { 8 | position: sticky; 9 | top: 4rem; 10 | height: calc(100vh - 10rem); 11 | overflow-y: auto; 12 | } 13 | 14 | order: 2; 15 | padding-top: 0.75rem; 16 | padding-bottom: 1.5rem; 17 | vertical-align: top; 18 | 19 | a { 20 | display: block; 21 | font-weight: $font-weight-light; 22 | padding-bottom: .25rem; 23 | } 24 | 25 | li { 26 | list-style: none; 27 | display: block; 28 | } 29 | 30 | li li { 31 | margin-left: 0.5rem; 32 | } 33 | 34 | .td-page-meta { 35 | a { 36 | font-weight: $font-weight-medium; 37 | } 38 | } 39 | 40 | #TableOfContents { 41 | // Hugo's ToC is a mouthful, this can be used to style the top level h2 entries. 42 | > ul > li > ul > li > a {} 43 | 44 | a { 45 | color: $gray-600; 46 | 47 | &:hover { 48 | color: $blue; 49 | text-decoration: none; 50 | } 51 | } 52 | } 53 | 54 | ul { 55 | padding-left: 0; 56 | } 57 | } -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/support/_mixins.scss: -------------------------------------------------------------------------------- 1 | // Some simple mixins. 2 | 3 | @mixin bg-gradient-variant($parent, $color,$ignore-warning: false) { 4 | #{$parent} { 5 | background: $color linear-gradient(180deg, mix($body-bg, $color, 15%), $color) repeat-x !important; 6 | } 7 | } 8 | 9 | @mixin link-variant($parent, $color, $hover-color, $underline: false) { 10 | #{$parent} { 11 | color: $color; 12 | 13 | &:hover { 14 | color: $hover-color; 15 | } 16 | 17 | @if $underline { 18 | text-decoration: underline; 19 | } 20 | } 21 | } 22 | 23 | @mixin optional-at-root($sel) { 24 | @at-root #{if(not &, $sel, selector-append(&, $sel))} { 25 | @content; 26 | } 27 | } 28 | 29 | // placeholder allows styling of the placeholder used in search input etc. 30 | @mixin placeholder { 31 | @include optional-at-root("::-webkit-input-placeholder") { 32 | @content; 33 | } 34 | 35 | 36 | @include optional-at-root(":-moz-placeholder") { 37 | @content; 38 | } 39 | 40 | 41 | @include optional-at-root("::-moz-placeholder") { 42 | @content; 43 | } 44 | 45 | 46 | @include optional-at-root(":-ms-input-placeholder") { 47 | @content; 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /website/static/social/boxed-lf-devstats.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /website/themes/docsy/layouts/blog/baseof.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | {{ partial "head.html" . }} 5 | 6 | 7 |
    8 | {{ partial "navbar.html" . }} 9 |
    10 |
    11 |
    12 |
    13 |
    14 | {{ partial "sidebar.html" . }} 15 |
    16 |
    17 | {{ partial "toc.html" . }} 18 |
    19 |
    20 | {{ with .CurrentSection.OutputFormats.Get "rss" -}} 21 | 22 | RSS 23 | 24 | {{ end -}} 25 | {{ block "main" . }}{{ end }} 26 |
    27 |
    28 |
    29 | {{ partial "footer.html" . }} 30 |
    31 | {{ partial "scripts.html" . }} 32 | 33 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/js/search.js: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright 2018 Google LLC 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | https://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | (function($) { 18 | 19 | 'use strict'; 20 | 21 | var Search = { 22 | init: function() { 23 | $(document).ready(function() { 24 | $(document).on('keypress', '.td-search-input', function(e) { 25 | if (e.keyCode !== 13) { 26 | return 27 | } 28 | 29 | var query = $(this).val(); 30 | var searchPage = "{{ "search/" | absURL }}?q=" + query; 31 | document.location = searchPage; 32 | 33 | return false; 34 | }); 35 | 36 | }); 37 | }, 38 | }; 39 | 40 | Search.init(); 41 | 42 | 43 | }(jQuery)); 44 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/scss/_colors.scss: -------------------------------------------------------------------------------- 1 | // Add some local palette classes so you can do -bg-warning -text-warning etc. Even -bg-1 if you want to paint by numbers. 2 | @mixin palette-variant($color-name, $color-value) { 3 | $text-color: color-yiq($color-value); 4 | $link-color: mix($blue, $text-color, lightness($color-value)); 5 | 6 | $link-hover-color: rgba($link-color, .5) !default; 7 | 8 | .-bg-#{$color-name} { 9 | color: $text-color; 10 | background-color: $color-value; 11 | } 12 | 13 | // Make links in paragraphs stand out more. 14 | @include link-variant(".-bg-#{$color-name} p > a", $link-color, $link-hover-color, false); 15 | 16 | 17 | .-text-#{$color-name} { 18 | color: $color-value; 19 | } 20 | } 21 | 22 | @each $color, $value in $colors { 23 | @include palette-variant($color, $value); 24 | } 25 | 26 | @each $color, $value in $theme-colors { 27 | @include palette-variant($color, $value); 28 | } 29 | 30 | @each $color, $value in $grays { 31 | @include palette-variant($color, $value); 32 | } 33 | 34 | // This allows "painting by numbers", i.e. picking colors by a shortcode Ordianal. 35 | @for $i from 1 through length($td-box-colors) { 36 | $value: nth($td-box-colors, $i); 37 | $name: $i - 1; 38 | $text-color: color-yiq($value); 39 | 40 | @include palette-variant($name, $value); 41 | } -------------------------------------------------------------------------------- /website/themes/docsy/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | We'd love to accept your patches and contributions to this project. There are 4 | just a few small guidelines you need to follow. 5 | 6 | ## Contributor License Agreement 7 | 8 | Contributions to this project must be accompanied by a Contributor License 9 | Agreement. You (or your employer) retain the copyright to your contribution; 10 | this simply gives us permission to use and redistribute your contributions as 11 | part of the project. Head over to to see 12 | your current agreements on file or to sign a new one. 13 | 14 | You generally only need to submit a CLA once, so if you've already submitted one 15 | (even if it was for a different project), you probably don't need to do it 16 | again. 17 | 18 | ## Code reviews 19 | 20 | All submissions, including submissions by project members, require review. We 21 | use GitHub pull requests for this purpose. Consult 22 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more 23 | information on using pull requests. 24 | 25 | ## Community Guidelines 26 | 27 | This project follows 28 | [Google's Open Source Community Guidelines](https://opensource.google.com/conduct/). 29 | 30 | ## How to contribute 31 | 32 | See the [contribution 33 | guidelines](https://www.docsy.dev/docs/contribution-guidelines/) 34 | in the Docsy user guide. 35 | -------------------------------------------------------------------------------- /website/themes/docsy/assets/js/mermaid.js: -------------------------------------------------------------------------------- 1 | {{ with .Site.Params.mermaid }} 2 | {{ if .enable }} 3 | (function($) { 4 | var needMermaid = false; 5 | $('.language-mermaid').parent().replaceWith(function() { 6 | needMermaid = true; 7 | return $('
    ').text($(this).text());
 8 |     });
 9 | 
10 |     if (!needMermaid)  {
11 |         mermaid.initialize({startOnLoad: false});
12 |         return;
13 |     }
14 | 
15 |     var params = {{ . | jsonify | safeJS }};
16 | 
17 |     // site params are stored with lowercase keys; lookup correct casing
18 |     // from Mermaid default config.
19 |     var norm = function(defaultConfig, params) {
20 |         var result = {};
21 |         for (const key in defaultConfig) {
22 |             const keyLower = key.toLowerCase();
23 |             if (defaultConfig.hasOwnProperty(key) && params.hasOwnProperty(keyLower)) {
24 |                 if (typeof defaultConfig[key] === "object") {
25 |                     result[key] = norm(defaultConfig[key], params[keyLower]);
26 |                 } else {
27 |                     result[key] = params[keyLower];
28 |                 }
29 |             }
30 |         }
31 |         return result;
32 |     };
33 |     var settings = norm(mermaid.mermaidAPI.defaultConfig, params);
34 |     settings.startOnLoad = true;
35 |     mermaid.initialize(settings);
36 | })(jQuery);
37 | {{ end }}
38 | {{ end }}
39 | 


--------------------------------------------------------------------------------
/website/static/social/twitch.svg:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/blog/list.html:
--------------------------------------------------------------------------------
 1 | {{ define "main" }}
 2 | {{ if .Parent.IsHome }}
 3 | {{ $.Scratch.Set "blog-pages" (where .Site.RegularPages "Section" .Section) }}
 4 | {{ else }}
 5 | {{$.Scratch.Set "blog-pages" .Pages }}
 6 | {{ end }}
 7 | 
 8 | 
    
 9 | 	
    
10 | 		{{- if .Pages -}}
11 | 		{{ $pag := .Paginate (( $.Scratch.Get "blog-pages").GroupByDate "2006")}}
12 | 			{{ range $pag.PageGroups }}
13 | 			
    {{ T "post_posts_in" }} {{ .Key }}
    
14 | 			
      
15 | 				{{ range .Pages }}
16 | 				
    • 
17 | 					
      
18 | 						
      {{ .LinkTitle }}
      
19 | 						
      {{ .Date.Format ($.Param "time_format_blog") }} {{ T "ui_in"}} {{ .CurrentSection.LinkTitle }}
      
20 | 						{{ partial "featured-image.html" (dict "p" . "w" 250 "h" 125 "class" "float-left mr-3 pt-1 d-none d-md-block") }}
21 | 						
      {{ .Plain | safeHTML | truncate 250 }}
      
22 | 						
      {{ T "ui_read_more"}}
      
23 | 					
      
24 | 				
      • 
25 | 				{{ end }}
26 | 			
    
27 | 			{{ end }}
28 | 		{{ end }}
29 | 	
    
30 | 
    
31 | 
    
32 | 	
    
33 | 		{{ if .Pages }}
34 | 			{{ template "_internal/pagination.html" . }}
35 | 		{{ end }}
36 | 	
    
37 | 
    
38 | {{ end }}


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/partials/search-input.html:
--------------------------------------------------------------------------------
 1 | {{ if or .Site.Params.gcs_engine_id .Site.Params.algolia_docsearch }}
 2 | 
 3 | {{ else if .Site.Params.offlineSearch }}
 4 | {{ $offlineSearchIndex := resources.Get "json/offline-search-index.json" | resources.ExecuteAsTemplate "offline-search-index.json" . }}
 5 | {{/* Use `md5` as finger print hash function to shorten file name to avoid `file name too long` error. */}}
 6 | {{ $offlineSearchIndexFingerprint := $offlineSearchIndex | resources.Fingerprint "md5" }}
 7 | 
24 | {{ end }}
25 | 


--------------------------------------------------------------------------------
/.github/settings.yml:
--------------------------------------------------------------------------------
 1 | repository:
 2 |   # See https://developer.github.com/v3/repos/#edit for all available settings.
 3 | 
 4 |   # The name of the repository. Changing this will rename the repository
 5 |   name: cartografos
 6 | 
 7 |   # A short description of the repository that will show up on GitHub
 8 |   description: The Cartografos working group aims to provide tools to help adopters and end-users to navigate the CNCF landscape and the wider cloud native ecosystem.
 9 | 
10 |   # A URL with more information about the repository
11 |   homepage: https://cncf.io/projects
12 |   
13 |   # Collaborators: give specific users access to this repository.
14 |   # Note: changing this file will update the users visible in Github UI 
15 |   # note that the permissions below may provide wider access than needed for
16 |   # a specific role, and we trust these individuals to act according to their
17 |   # role. If there are questions, please contact one of the chairs.
18 | collaborators:
19 |   # Chairs
20 |   - username: xmulligan
21 |     permission: admin
22 | 
23 |   - username: oicheryl
24 |     permission: admin
25 |     
26 |   - username: siforster
27 |     permission: admin
28 |     
29 |   - username: daniellemcook
30 |     permission: admin
31 | 
32 |   - username: Deep-Cyber
33 |     permission: admin
34 | 
35 |   - username: robertglenn
36 |     permission: admin
37 |     
38 |     # Triage Team
39 |     # manage issues (edit labels, occasionally edit)
40 |     # needs "push" permission, even though triage team should not merge PRs
41 | 


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/swagger/baseof.html:
--------------------------------------------------------------------------------
 1 | 
 2 | 
 3 |   
 4 |     {{ partial "head.html" . }}
 5 |     {{ $baseurl := urls.Parse site.BaseURL }}
 6 |     {{ if .IsHome }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{ . }} | {{ end }}{{ .Site.Title }}{{ end }}
 7 |     
 8 |   
 9 |   
10 |     
    
11 |       {{ partial "navbar.html" . }}
12 |     
    
13 |     
    
14 |       
    
15 |         
    
16 |           
    
17 |             {{ partial "sidebar.html" . }}
18 |           
    
19 |           
    
20 |             {{ partial "toc.html" . }}
21 |           
    
22 |           
    
23 |             {{ if not .Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" . }}{{ end }}
24 |             
25 |             
26 |             {{ block "main" . }}{{ end }}
27 |           
    
28 |         
    
29 |       
    
30 |       {{ partial "footer.html" . }}
31 |     
    
32 |     {{ partial "scripts.html" . }}
33 |   
34 | 


--------------------------------------------------------------------------------
/website/themes/docsy/assets/scss/main.scss:
--------------------------------------------------------------------------------
 1 | @import "support/functions";
 2 | @import "variables_project";
 3 | @import "variables";
 4 | @import "support/mixins";
 5 | 
 6 | @import "../vendor/bootstrap/scss/bootstrap";
 7 | 
 8 | @import "../vendor/Font-Awesome/scss/fontawesome.scss";
 9 | @import "../vendor/Font-Awesome/scss/solid.scss";
10 | @import "../vendor/Font-Awesome/scss/brands.scss";
11 | 
12 | @import "support/utilities";
13 | @import "colors";
14 | @import "boxes";
15 | @import "blog";
16 | @import "code";
17 | @import "nav";
18 | @import "sidebar-tree";
19 | @import "sidebar-toc";
20 | @import "buttons";
21 | @import "breadcrumb";
22 | @import "alerts";
23 | @import "content";
24 | @import "search";
25 | @import "main-container";
26 | @import "blocks/blocks";
27 | @import "section-index";
28 | @import "pageinfo";
29 | 
30 | @if $td-enable-google-fonts {
31 |     @import url($web-font-path);
32 | }
33 | 
34 | footer {
35 |     min-height: 150px;
36 |     overflow: auto;
37 |     
38 |     @include media-breakpoint-down(md) {
39 |          min-height: 200px;
40 |     }
41 | }
42 | 
43 | // Adjust anchors vs the fixed menu.
44 | @include media-breakpoint-up(md) {
45 |     .td-offset-anchor:target {
46 |         display: block;
47 |         position: relative;
48 |         top: -4rem;
49 |         visibility: hidden;
50 |     }
51 | 
52 |     h2[id]:before, h3[id]:before, h4[id]:before, h5[id]:before {
53 |         display: block;
54 |         content: " ";
55 |         margin-top: -5rem;
56 |         height: 5rem;
57 |         visibility: hidden;
58 |     }
59 | }
60 | 
61 | @import "styles_project";


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/partials/head.html:
--------------------------------------------------------------------------------
 1 | 
 2 | 
 3 | {{ hugo.Generator }}
 4 | {{ if eq (getenv "HUGO_ENV") "production" }}
 5 | 
 6 | {{ else }}
 7 | 
 8 | {{ end }}
 9 | {{ range .AlternativeOutputFormats -}}
10 | 
11 | {{ end -}}
12 | {{ partialCached "favicons.html" . }}
13 | {{ if .IsHome }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{ . }} | {{ end }}{{ .Site.Title }}{{ end }}
14 | {{- template "_internal/opengraph.html" . -}}
15 | {{- template "_internal/google_news.html" . -}}
16 | {{- template "_internal/schema.html" . -}}
17 | {{- template "_internal/twitter_cards.html" . -}}
18 | {{ if eq (getenv "HUGO_ENV") "production" }}
19 | {{ template "_internal/google_analytics_async.html" . }}
20 | {{ end }}
21 | {{ partialCached "head-css.html" . "asdf" }}
22 | 
26 | {{ if .Site.Params.offlineSearch }}
27 | 
31 | {{end}}
32 | {{ with .Site.Params.prism_syntax_highlighting }}
33 | 
34 | 
35 | {{ end }}
36 | {{ partial "hooks/head-end.html" . }}
37 | 


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/partials/scripts.html:
--------------------------------------------------------------------------------
 1 | 
 2 | 
 3 | 
 4 | 
 5 | {{ if .Site.Params.mermaid.enable }}
 6 | 
 7 | 
 8 | {{ end }}
 9 | 
10 | {{ $jsBase := resources.Get "js/base.js" }}
11 | {{ $jsAnchor := resources.Get "js/anchor.js" }}
12 | {{ $jsSearch := resources.Get "js/search.js" | resources.ExecuteAsTemplate "js/search.js" .Site.Home }}
13 | {{ $jsMermaid := resources.Get "js/mermaid.js" | resources.ExecuteAsTemplate "js/mermaid.js" . }}
14 | {{ if .Site.Params.offlineSearch }}
15 | {{ $jsSearch = resources.Get "js/offline-search.js" }}
16 | {{ end }}
17 | {{ $js := (slice $jsBase $jsAnchor $jsSearch $jsMermaid) | resources.Concat "js/main.js" }}
18 | {{ if .Site.IsServer }}
19 | 
20 | {{ else }}
21 | {{ $js := $js | minify | fingerprint }}
22 | 
23 | {{ end }}
24 | {{ with .Site.Params.prism_syntax_highlighting }}
25 | 
26 | 
27 | {{ end }}
28 | {{ partial "hooks/body-end.html" . }}
29 | 


--------------------------------------------------------------------------------
/website/layouts/partials/navbar.html:
--------------------------------------------------------------------------------
 1 | {{ $cover := .HasShortcode "blocks/cover" }}
 2 | 
33 | 


--------------------------------------------------------------------------------
/website/assets/scss/_sidebar-toc.scss:
--------------------------------------------------------------------------------
 1 | //
 2 | // Right side toc
 3 | //
 4 | .td-sidebar-toc {
 5 | 	padding-top: 5.3rem;
 6 | 	border-left: 1px solid $border-color;
 7 | 
 8 | 	@supports (position: sticky) {
 9 | 		position: sticky;
10 | 		top: 4rem;
11 | 		height: calc(100vh - 6rem);
12 | 		overflow-y: auto;
13 | 	}
14 | 
15 | 	order: 2;
16 | 	padding-bottom: 1.5rem;
17 | 	vertical-align: top;
18 | }
19 | 
20 | .td-page-meta {
21 | 	a {
22 | 		display: block;
23 | 		margin-bottom: 1rem;
24 | 		letter-spacing: 0.02em;
25 | 		font-weight: 500;
26 | 	}
27 | }
28 | 
29 | .td-toc {
30 | 	a {
31 | 		display: block;
32 | 		font-weight: $font-weight-light;
33 | 		padding-bottom: 0.25rem;
34 | 	}
35 | 
36 | 	li {
37 | 		list-style: none;
38 | 		display: block;
39 | 	}
40 | 
41 | 	li li {
42 | 		margin-left: 0.5rem;
43 | 	}
44 | 
45 | 	#TableOfContents {
46 | 		a {
47 | 			color: $gray-600;
48 | 
49 | 			&:hover {
50 | 				color: $blue;
51 | 				text-decoration: none;
52 | 			}
53 | 		}
54 | 	}
55 | 
56 | 	ul {
57 | 		padding-left: 0;
58 | 	}
59 | }
60 | 
61 | #TableOfContents {
62 | 	a {
63 | 		font-weight: 400;
64 | 		color: unset;
65 | 	}
66 | 
67 | 	// reset all ul.
68 | 	ul {
69 | 		margin-block-start: 0;
70 | 		margin-block-end: 0;
71 | 		margin-inline-start: 0;
72 | 		margin-inline-end: 0;
73 | 		padding-inline-start: 0;
74 | 	}
75 | 	> ul {
76 | 		margin-bottom: 0;
77 | 		list-style: none;
78 | 		margin-left: 0.5rem !important;
79 | 		> li:first-child > ul {
80 | 			list-style-type: none;
81 | 		}
82 | 
83 | 		// hides subheadings from TOC
84 | 		ul {
85 | 			display: none;
86 | 		}
87 | 
88 | 		li {
89 | 			margin: 1em 0;
90 | 		}
91 | 	}
92 | }
93 | 
94 | div.toc-header {
95 | 	font-weight: 700;
96 | 	letter-spacing: 0.02em;
97 | }
98 | 


--------------------------------------------------------------------------------
/website/themes/docsy/assets/scss/_content.scss:
--------------------------------------------------------------------------------
 1 | //
 2 | // Style Markdown content
 3 | //
 4 | 
 5 | .td-content {
 6 |     order: 1;
 7 | 
 8 |     p, li, td {
 9 |         font-weight: $font-weight-body-text;
10 |     }
11 | 
12 |     > h1 {
13 |         font-weight: $font-weight-bold;
14 |         margin-bottom: 1rem;
15 |     }
16 | 
17 |     > h2 {
18 |         margin-bottom: 1rem;
19 |     }
20 | 
21 |     > h2:not(:first-child) {
22 |         margin-top: 3rem;
23 |     }
24 | 
25 |     > h2 + h3 {
26 |          margin-top: 1rem;
27 |     }
28 | 
29 |     > h3, > h4, > h5, > h6 {
30 |         margin-bottom: 1rem;
31 |         margin-top: 2rem;
32 |     }
33 | 
34 |     img {
35 |         @extend .img-fluid;
36 |     }
37 | 
38 |     > table {
39 |         @extend .table-striped;
40 | 
41 |         @extend .table-responsive;
42 | 
43 |         @extend .table;
44 |     }
45 | 
46 |     > blockquote {
47 |         padding: 0 0 0 1rem;
48 |         margin-bottom: $spacer;
49 |         color: $gray-600;
50 |         border-left: 6px solid $secondary;
51 |     }
52 | 
53 |     > ul li, > ol li {
54 |         margin-bottom: .25rem;
55 |     }
56 | 
57 |     strong {
58 |         font-weight: $font-weight-bold;
59 |     }
60 | 
61 |     > pre, > .highlight, > .lead, > h1, > h2, > ul, > ol, > p, > blockquote, > dl dd, .footnotes, > .alert {
62 |         @extend .td-max-width-on-larger-screens;
63 |     }
64 | 
65 |     .alert:not(:first-child) {
66 |         margin-top: 2 * $spacer;
67 |         margin-bottom: 2 * $spacer;
68 |     }
69 | 
70 |     .lead {
71 |         margin-bottom: 1.5rem;
72 |     }
73 | }
74 | 
75 | .td-title {
76 |     margin-top: 1rem;
77 |     margin-bottom: .5rem;
78 | 
79 |     @include media-breakpoint-up(sm) {
80 |         font-size: 3rem;
81 |     }
82 | }


--------------------------------------------------------------------------------
/website/static/social/instagram.svg:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/partials/footer.html:
--------------------------------------------------------------------------------
 1 | {{ $links := .Site.Params.links }}
 2 | 
    
 3 |   
    
 4 |     
    
 5 |       
    
 6 |         {{ with $links }}
 7 |         {{ with index . "user"}}
 8 |         {{ template "footer-links-block"  . }}
 9 |         {{ end }}
10 |         {{ end }}
11 |       
    
12 |       
    
13 |         {{ with $links }}
14 |         {{ with index . "developer"}}
15 |         {{ template "footer-links-block"  . }}
16 |         {{ end }}
17 |         {{ end }}
18 |       
    
19 |       
    
20 |         {{ with .Site.Params.copyright }}© {{ now.Year}} {{ .}} {{ T "footer_all_rights_reserved" }}{{ end }}
21 |         {{ with .Site.Params.privacy_policy }}{{ T "footer_privacy_policy" }}{{ end }}
22 | 	{{ if not .Site.Params.ui.footer_about_disable }}
23 |     {{ with .Site.GetPage "about" }}
    {{ .Title }}
    {{ end }}
24 |   {{ end }}
25 |         {{ partial "hooks/footer-end.html" . }}
26 |       
    
27 |     
    
28 |   
    
29 | 
    
30 | {{ define "footer-links-block" }}
31 | 
      
32 |   {{ range . }}
33 |   
    • 
34 |     
35 |       
36 |     
37 |   
      • 
38 |   {{ end }}
39 | 
    
40 | {{ end }}
41 | 


--------------------------------------------------------------------------------
/website/themes/docsy/assets/scss/support/_utilities.scss:
--------------------------------------------------------------------------------
 1 | // Mixins
 2 | 
 3 | @mixin optional-at-root($sel) {
 4 |     @at-root #{if(not &, $sel, selector-append(&, $sel))} {
 5 |         @content;
 6 |     }
 7 | }
 8 | 
 9 | @mixin placeholder {
10 |     @include optional-at-root("::-webkit-input-placeholder") {
11 |         @content;
12 |     }
13 | 
14 | 
15 |     @include optional-at-root(":-moz-placeholder") {
16 |         @content;
17 |     }
18 | 
19 | 
20 |     @include optional-at-root("::-moz-placeholder") {
21 |         @content;
22 |     }
23 | 
24 | 
25 |     @include optional-at-root(":-ms-input-placeholder") {
26 |         @content;
27 |     }
28 | }
29 | 
30 | // Common util classes.
31 | 
32 | .td-border-top {
33 |     border: none;
34 |     border-top: 1px solid #eee;
35 | }
36 | 
37 | .td-border-none {
38 |     border: none;
39 | }
40 | 
41 | .td-block-padding {
42 |     padding-top: $td-block-space-top-base ;
43 |     padding-bottom: $td-block-space-bottom-base;
44 | 
45 |     @include media-breakpoint-up(md) {
46 |         padding-top: $td-block-space-top-base * 1.25;
47 |         padding-bottom: $td-block-space-bottom-base * 1.25;
48 |     }
49 | }
50 | 
51 | .td-overlay {
52 |     position: relative;
53 | 
54 |     &::after {
55 |         content: "";
56 |         position: absolute;
57 |         top: 0;
58 |         right: 0;
59 |         bottom: 0;
60 |         left: 0;
61 |     }
62 | 
63 |     &--dark::after {
64 |         background-color: rgba($dark, 0.3);
65 |     }
66 | 
67 |     &--light::after {
68 |         background-color: rgba($light, 0.3);
69 |     }
70 | 
71 |     &__inner {
72 |         position: relative;
73 |         z-index: 1;
74 |     }
75 | }
76 | 
77 | .td-max-width-on-larger-screens {
78 |     @include media-breakpoint-up(lg) {
79 |         max-width: 80%;
80 |     }
81 | 
82 | }


--------------------------------------------------------------------------------
/website/assets/scss/_main.scss:
--------------------------------------------------------------------------------
 1 | body {
 2 | 	background-color: #fdfdfd;
 3 | }
 4 | 
 5 | html .row {
 6 | 	margin-right: unset;
 7 | 	margin-left: unset;
 8 | }
 9 | 	
10 | // Stops links pushing out container.
11 | // Experimental usage on P tag.
12 | // Due to Archived project github link.
13 | a,
14 | p {
15 | 	overflow-wrap: break-word;
16 | 	word-wrap: break-word;
17 | 	word-break: break-all;
18 | 	word-break: break-word;
19 | 	hyphens: auto;
20 | }
21 | 
22 | // Adds some extra space to anchor targets.
23 | *:target {
24 | 	scroll-margin-top: 2rem;
25 | 	@media (min-width: 768px) {
26 | 		scroll-margin-top: 3rem;
27 | 	}
28 | }
29 | 
30 | @media (max-width: 992px) {
31 | 	.section-group {
32 | 		section:first-child {
33 | 			padding-top: 4rem;
34 | 		}
35 | 		section::last-child {
36 | 			padding-bottom: 4rem;
37 | 		}
38 | 	}
39 | 
40 | 	.feature-block + .feature-block {
41 | 		margin-top: 4em;
42 | 	}
43 | 
44 | 	.mb-10 {
45 | 		margin-bottom: 6em;
46 | 	}
47 | }
48 | 
49 | @media (min-width: 576px) {
50 | 	.container-sm,
51 | 	.container {
52 | 		max-width: 100% !important;
53 | 	}
54 | }
55 | 
56 | @media (min-width: 768px) {
57 | 	// Align main content on desktop.
58 | 	.td-main main {
59 | 		padding-top: 9.5rem;
60 | 	}
61 | 	.td-box .row {
62 | 		padding-left: 0vw;
63 | 		padding-right: 0vw;
64 | 		flex-direction: row;
65 | 	}
66 | }
67 | 
68 | section {
69 | 	padding-top: 2rem;
70 | 	padding-bottom: 2rem;
71 | }
72 | 
73 | .td-box--gray-900 {
74 | 	color: #fff;
75 | 	background-color: #403f4c;
76 | }
77 | .td-box--gray-700 {
78 | 	color: #fff;
79 | 	background-color: #12182c; // WCAG.
80 | }
81 | .td-box--gray-300 {
82 | 	color: #000;
83 | 	background-color: #f5f6ff;
84 | }
85 | .td-box--gray-200 {
86 | 	color: #000;
87 | 	background-color: #eaeeff;
88 | }
89 | 
90 | .td-box--white p > a {
91 | 	color: $link-color;
92 | }
93 | 


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/partials/navbar.html:
--------------------------------------------------------------------------------
 1 | {{ $cover := .HasShortcode "blocks/cover" }}
 2 | 
34 | 


--------------------------------------------------------------------------------
/website/themes/docsy/userguide/content/en/docs/Examples/_index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: "Examples"
 3 | weight: 8
 4 | description: >
 5 |   Some examples of Docsy in action!
 6 | ---
 7 | 
 8 | One of the best ways to see what Docsy can do, and learn how to configure a site with it, is to see some real projects. In addition to our provided Docsy Example Project, there are several live sites already using the theme. Please add your own examples once you've got a production site up and running with Docsy!
 9 | 
10 | ## Docsy theme examples
11 | 
12 | Example sites that have low to no customization:
13 | 
14 | | Site  | Repo (if public)  |
15 | |---|---|
16 | | [This Docsy documentation site](/docs) | https://github.com/google/docsy |
17 | | ["Goldydocs" - a Docsy example site](https://example.docsy.dev) | https://github.com/google/docsy-example  |
18 | | https://www.kubeflow.org/  | https://github.com/kubeflow/website  |
19 | | https://agones.dev/site/ | https://github.com/GoogleCloudPlatform/agones/tree/master/site |
20 | | https://googlecontainertools.github.io/kpt/ | https://github.com/GoogleContainerTools/kpt/tree/master/docs | 
21 | | [Navidrome Music Server](https://www.navidrome.org) | https://github.com/navidrome/website | 
22 | | https://docs.agilebase.co.uk/ | https://github.com/okohll/abdocs | 
23 | 
24 | ## Customized Docsy examples
25 | 
26 | Example sites that include a moderate to high amount of customization:
27 | 
28 | | Site  | Repo (if public)  |
29 | |---|---|
30 | | [Knative](https://knative.dev) | https://github.com/knative/docs and https://github.com/knative/website |
31 | | [Apache Airflow](https://airflow.apache.org/) | https://github.com/apache/airflow-site/ |
32 | | [Docsy Just Docs](https://docsyjustdocs.netlify.com/) | https://github.com/LisaFC/justdocs |
33 | | [Thunderhead Engineering Product Support](https://support.thunderheadeng.com/) | https://gitlab.com/tecidev/support (private) |
34 | 


--------------------------------------------------------------------------------
/website/themes/docsy/userguide/content/en/_index.html:
--------------------------------------------------------------------------------
 1 | +++
 2 | title = "Docsy"
 3 | linkTitle = "Docsy"
 4 | 
 5 | +++
 6 | 
 7 | {{< blocks/cover title="Welcome to Docsy!" image_anchor="top" height="full" color="orange" >}}
 8 | 
    
 9 | 	}}">
10 | 		Learn More 
11 | 	
12 | 	
13 | 		Download 
14 | 	
15 | 	
    A Hugo theme for creating great technical documentation sites
    
16 | 	{{< blocks/link-down color="info" >}}
17 | 
    
18 | {{< /blocks/cover >}}
19 | 
20 | 
21 | {{% blocks/lead color="primary" %}}
22 | Docsy is a theme for the Hugo static site generator that's specifically designed for technical documentation sets. Our aim is to help you get a working documentation site up and running as easily as possible, so you can concentrate on creating great content for your users.
23 | {{% /blocks/lead %}}
24 | 
25 | {{< blocks/section color="dark" type="features">}}
26 | {{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="/docs/examples/" %}}
27 | As well as our example site, there's a growing number of projects using Docsy for their doc sites.
28 | {{% /blocks/feature %}}
29 | 
30 | 
31 | {{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}}
32 | We do a [Pull Request](https://github.com/google/docsy/pulls) contributions workflow on **GitHub**. New users are always welcome!
33 | {{% /blocks/feature %}}
34 | 
35 | 
36 | {{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}
37 | Find out about new features and how our users are using Docsy.
38 | {{% /blocks/feature %}}
39 | 
40 | 
41 | {{< /blocks/section >}}
42 | 
43 | 


--------------------------------------------------------------------------------
/website/assets/scss/_search.scss:
--------------------------------------------------------------------------------
 1 | // Search form.
 2 | .td-sidebar__search {
 3 | 	background-color: transparent;
 4 | 	@media (max-width: 767px) {
 5 | 		margin-top: 1rem;
 6 | 	}
 7 | 	@media (min-width: 768px) {
 8 | 		padding-top: 0.5rem !important;
 9 | 		padding-left: 1.5rem;
10 | 		padding-right: 1rem;
11 | 		padding-bottom: 1rem;
12 | 	}
13 | 	@media (min-width: 1300px) {
14 | 		padding-left: 2.5rem;
15 | 	}
16 | 	.add-search-icon {
17 | 		position: relative;
18 | 		width: 100%;
19 | 		@media (max-width: 767px) {
20 | 			margin-bottom: 10px;
21 | 		}
22 | 		@media (min-width: 768px) {
23 | 			width: calc(100% - 20px);
24 | 		}
25 | 		svg {
26 | 			position: absolute;
27 | 			top: 50%;
28 | 			left: 0;
29 | 			transform: translateY(-50%);
30 | 			pointer-events: none;
31 | 			height: 21px;
32 | 			@media (min-width: 992px) {
33 | 				height: 24px;
34 | 				transform: translateY(-60%);
35 | 			}
36 | 		}
37 | 		.td-search-input {
38 | 			border: none;
39 | 			border-bottom: $black 2px solid;
40 | 			border-radius: 0;
41 | 			background-color: transparent;
42 | 			box-shadow: none;
43 | 			line-height: 1;
44 | 			color: $black;
45 | 			font-weight: 300;
46 | 			font-size: 16px;
47 | 			padding-top: 5px;
48 | 			padding-bottom: 5px;
49 | 			padding-right: 0;
50 | 			padding-left: calc(20px + 20px);
51 | 			@media (min-width: 768px) {
52 | 				padding-left: 30px;
53 | 				font-size: 20px;
54 | 			}
55 | 			@media (min-width: 992px) {
56 | 				padding-left: 35px;
57 | 			}
58 | 			@media (min-width: 1100px) {
59 | 				padding-left: calc(20px + 20px);
60 | 				font-size: 20px;
61 | 			}
62 | 
63 | 			&::placeholder {
64 | 				@media (min-width: 768px) {
65 | 					line-height: 1;
66 | 					color: $black;
67 | 				}
68 | 				@media (min-width: 1100px) {
69 | 					font-size: 20px;
70 | 				}
71 | 			}
72 | 			&:focus {
73 | 				background-color: transparent;
74 | 				border-bottom: $black 2px solid;
75 | 			}
76 | 		}
77 | 	}
78 | }
79 | 


--------------------------------------------------------------------------------
/website/layouts/partials/page-meta-links.html:
--------------------------------------------------------------------------------
 1 | {{ $path := "" }}
 2 | {{ with .File }}
 3 |   {{ $path = printf "%s/%s" .Lang .Path }}
 4 | {{ else }}
 5 |   {{ $path = printf "%s/%s" .Lang .Path }}
 6 | {{ end }}
 7 | {{ $pathFormatted := replace $path "\\" "/" }}
 8 | {{- $prefix := index (split $path "/") 0 -}}
 9 | {{- $github := index ($.Site.Param "github") $prefix -}}
10 | {{ if not $github }}{{- $github = ($.Site.Param "github") -}}{{ end }}
11 | {{ if $github }}
12 | {{ $gh_repo := index $github "repo" }}
13 | {{ $gh_subdir := index $github "subdir" }}
14 | {{ $gh_project_repo := index $github "project_repo" }}
15 | {{ $gh_branch := (default "main" (index $github "branch")) }}
16 | {{ if $gh_repo }}
17 | 
    
18 | {{ $gh_repo_path := printf "%s/content/%s" $gh_branch $pathFormatted }}
19 | {{ if $gh_subdir }}
20 | {{ $gh_repo_path = printf "%s/%s/content/%s" $gh_branch $gh_subdir $pathFormatted }}
21 | {{ end }}
22 | {{ $editURL := printf "%s/edit/%s" $gh_repo $gh_repo_path }}
23 | {{ $createURL := printf "%s/edit/%s" $gh_repo $gh_repo_path }}
24 | {{ $issuesURL := printf "%s/issues/new?title=%s" $gh_repo (htmlEscape $.Title )}}
25 | {{ $newPageStub := resources.Get "stubs/new-page-template.md" }}
26 | {{ $newPageQS := querify "value" $newPageStub.Content "filename" "change-me.md" | safeURL }}
27 | {{ $newPageURL := printf "%s/new/%s?%s"  $gh_repo $gh_repo_path $newPageQS }}
28 | 
29 |  {{ T "post_edit_this" }}
30 |  {{ T "post_create_issue" }}
31 | {{ if $gh_project_repo }}
32 | {{ $project_issueURL := printf "%s/issues/new" $gh_project_repo }}
33 |  {{ T "post_create_project_issue" }}
34 | {{ end }}
35 | 
    
36 | {{ end }}
37 | {{ end }}
38 | 


--------------------------------------------------------------------------------
/website/layouts/partials/head.html:
--------------------------------------------------------------------------------
 1 | 
 2 | 
 3 | {{ hugo.Generator }}
 4 | {{ if and hugo.IsProduction -}}
 5 | 
 6 | {{ else }}
 7 | 
 8 | {{ end }}
 9 | {{ range .AlternativeOutputFormats -}}
10 | 
11 | {{ end -}}
12 | {{ partialCached "favicons.html" . }}
13 | {{ if .IsHome }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{ . }} | {{ end }}{{ .Site.Title }}{{ end }}
14 | {{- template "_internal/opengraph.html" . -}}
15 | {{- template "_internal/schema.html" . -}}
16 | {{- partial "twitter_cards.html" . -}}
17 | 
18 | 
19 | 
20 | {{ if hugo.IsProduction }}
21 | 
22 | 
23 | 
30 | 
31 | {{ end }}
32 | {{ partialCached "head-css.html" . "asdf" }}
33 | 
37 | {{ if .Site.Params.offlineSearch }}
38 | 
42 | {{end}}
43 | {{ with .Site.Params.prism_syntax_highlighting }}
44 | 
45 | 
46 | {{ end }}
47 | {{ partial "hooks/head-end.html" . }}
48 | 


--------------------------------------------------------------------------------
/website/layouts/partials/feedback.html:
--------------------------------------------------------------------------------
 1 | 
16 | 
    
17 | 
18 | 
19 | 
20 | 
21 | 
24 | 
27 | 
    
28 | 
57 | 


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/partials/feedback.html:
--------------------------------------------------------------------------------
 1 | 
16 | 
17 | 
18 | 
19 | 
20 | 
23 | 
26 | 
58 | 


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/partials/page-meta-links.html:
--------------------------------------------------------------------------------
 1 | {{ if .Path }}
 2 | {{ $pathFormatted := replace .Path "\\" "/" }}
 3 | {{ $gh_repo := ($.Param "github_repo") }}
 4 | {{ $gh_subdir := ($.Param "github_subdir") }}
 5 | {{ $gh_project_repo := ($.Param "github_project_repo") }}
 6 | {{ $gh_branch := (default "master" ($.Param "github_branch")) }}
 7 | {{ if $gh_repo }}
 8 | 
    
 9 | {{ $gh_repo_path := printf "%s/content/%s" $gh_branch $pathFormatted }}
10 | {{ if and ($gh_subdir) (.Site.Language.Lang) }}
11 | {{ $gh_repo_path = printf "%s/%s/content/%s/%s" $gh_branch $gh_subdir ($.Site.Language.Lang) $pathFormatted }}
12 | {{ else if .Site.Language.Lang }}
13 | {{ $gh_repo_path = printf "%s/content/%s/%s" $gh_branch ($.Site.Language.Lang) $pathFormatted }}
14 | {{ else if $gh_subdir }}
15 | {{ $gh_repo_path = printf "%s/%s/content/%s" $gh_branch $gh_subdir $pathFormatted }}
16 | {{ end }}
17 | {{ $editURL := printf "%s/edit/%s" $gh_repo $gh_repo_path }}
18 | {{ $createURL := printf "%s/edit/%s" $gh_repo $gh_repo_path }}
19 | {{ $issuesURL := printf "%s/issues/new?title=%s" $gh_repo (htmlEscape $.Title )}}
20 | {{ $newPageStub := resources.Get "stubs/new-page-template.md" }}
21 | {{ $newPageQS := querify "value" $newPageStub.Content "filename" "change-me.md" | safeURL }}
22 | {{ $newPageURL := printf "%s/new/%s?%s"  $gh_repo $gh_repo_path $newPageQS }}
23 | 
24 |  {{ T "post_edit_this" }}
25 |  {{ T "post_create_child_page" }}
26 |  {{ T "post_create_issue" }}
27 | {{ if $gh_project_repo }}
28 | {{ $project_issueURL := printf "%s/issues/new" $gh_project_repo }}
29 |  {{ T "post_create_project_issue" }}
30 | {{ end }}
31 | 
    
32 | {{ end }}
33 | {{ end }}
34 | 


--------------------------------------------------------------------------------
/website/themes/docsy/assets/scss/_nav.scss:
--------------------------------------------------------------------------------
 1 | //
 2 | // Main navbar
 3 | //
 4 | 
 5 | .td-navbar-cover {
 6 |     background: $primary;
 7 | 
 8 |     @include media-breakpoint-up(md) {
 9 |         background: transparent !important;
10 | 
11 |         .nav-link {
12 |             text-shadow: 1px 1px 2px $dark;
13 |         }
14 | 
15 |     }
16 | 
17 |     &.navbar-bg-onscroll .nav-link {
18 |         text-shadow: none;
19 |     }
20 | }
21 | 
22 | .navbar-bg-onscroll {
23 |     background: $primary !important;
24 |     opacity: inherit;
25 | }
26 | 
27 | .td-navbar {
28 |     background: $primary;
29 |     min-height: 4rem;
30 |     margin: 0;
31 |     z-index: 32;
32 | 
33 |     @include media-breakpoint-up(md) {
34 |         position: fixed;
35 |         top: 0;
36 |         width: 100%;
37 |     }
38 | 
39 | 
40 |     .navbar-brand {
41 |         text-transform: none;
42 |         text-align: middle;
43 | 
44 |         .nav-link {
45 |             display: inline-block;
46 |             margin-right: -30px;
47 |         }
48 | 
49 |         svg {
50 |             display: inline-block;
51 |             margin: 0 10px;
52 |             height: 30px;
53 |         }
54 |     }
55 | 
56 |     .nav-link {
57 |         text-transform: none;
58 |         font-weight: $font-weight-bold;
59 |     }
60 | 
61 |     .td-search-input {
62 |         border: none;
63 | 
64 |         @include placeholder {
65 |             color: $navbar-dark-color;
66 |         }
67 |     }
68 | 
69 |     .dropdown {
70 |         min-width: 100px;
71 |     }
72 | 
73 |     @include media-breakpoint-down(md) {
74 |         padding-right: .5rem;
75 |         padding-left: .75rem;
76 | 
77 |         .td-navbar-nav-scroll {
78 |             max-width: 100%;
79 |             height: 2.5rem;
80 |             margin-top: .25rem;
81 |             overflow: hidden;
82 |             font-size: .875rem;
83 | 
84 |             .nav-link {
85 |                 padding-right: .25rem;
86 |                 padding-left: 0;
87 |             }
88 | 
89 |             .navbar-nav {
90 |                 padding-bottom: 2rem;
91 |                 overflow-x: auto;
92 |                 white-space: nowrap;
93 |                 -webkit-overflow-scrolling: touch;
94 | 
95 |             }
96 |         }
97 |     }
98 | }


--------------------------------------------------------------------------------
/website/themes/docsy/assets/js/base.js:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Copyright 2018 Google LLC
 3 | 
 4 | Licensed under the Apache License, Version 2.0 (the "License");
 5 | you may not use this file except in compliance with the License.
 6 | You may obtain a copy of the License at
 7 | 
 8 |     https://www.apache.org/licenses/LICENSE-2.0
 9 | 
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 | 
17 | (function($) {
18 | 
19 |     'use strict';
20 | 
21 |     $(function() {
22 |         $('[data-toggle="tooltip"]').tooltip();
23 |         $('[data-toggle="popover"]').popover();
24 | 
25 |         $('.popover-dismiss').popover({
26 |             trigger: 'focus'
27 |         })
28 |     });
29 | 
30 | 
31 |     function bottomPos(element) {
32 |         return element.offset().top + element.outerHeight();
33 |     }
34 | 
35 |     // Bootstrap Fixed Header
36 |     $(function() {
37 |         var promo = $(".js-td-cover");
38 |         if (!promo.length) {
39 |             return
40 |         }
41 | 
42 |         var promoOffset = bottomPos(promo);
43 |         var navbarOffset = $('.js-navbar-scroll').offset().top;
44 | 
45 |         var threshold = Math.ceil($('.js-navbar-scroll').outerHeight());
46 |         if ((promoOffset - navbarOffset) < threshold) {
47 |             $('.js-navbar-scroll').addClass('navbar-bg-onscroll');
48 |         }
49 | 
50 | 
51 |         $(window).on('scroll', function() {
52 |             var navtop = $('.js-navbar-scroll').offset().top - $(window).scrollTop();
53 |             var promoOffset = bottomPos($('.js-td-cover'));
54 |             var navbarOffset = $('.js-navbar-scroll').offset().top;
55 |             if ((promoOffset - navbarOffset) < threshold) {
56 |                 $('.js-navbar-scroll').addClass('navbar-bg-onscroll');
57 |             } else {
58 |                 $('.js-navbar-scroll').removeClass('navbar-bg-onscroll');
59 |                 $('.js-navbar-scroll').addClass('navbar-bg-onscroll--fade');
60 |             }
61 |         });
62 |     });
63 | 
64 | 
65 | }(jQuery));
66 | 


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/shortcodes/blocks/cover.html:
--------------------------------------------------------------------------------
 1 | {{ $_hugo_config := `{ "version": 1 }` }}
 2 | {{ $blockID := printf "td-cover-block-%d" .Ordinal }}
 3 | {{ $promo_image := (.Page.Resources.ByType "image").GetMatch "**background*" }}
 4 | {{ $logo_image := (.Page.Resources.ByType "image").GetMatch "**logo*" }}
 5 | {{ $col_id := .Get "color" | default "dark" }}
 6 | {{ $image_anchor := .Get "image_anchor" | default "smart" }}
 7 | {{ $logo_anchor := .Get "logo_anchor" | default "smart" }}
 8 | {{/* Height can be one of: auto, min, med, max, full. */}}
 9 | {{ $height := .Get "height" | default "max" }}
10 | {{ $byline := .Get "byline" | default "" }}
11 | {{ with $promo_image }}
12 | {{ $promo_image_big := (.Fill (printf "1920x1080 %s" $image_anchor)) }}
13 | {{ $promo_image_small := (.Fill (printf "960x540 %s" $image_anchor)) }}
14 | 
15 | 
16 | 
26 | {{ end }}
27 | 
    
28 |   
    
29 |     
    
30 |       
    
31 |         
    
32 |           {{ with .Get "title" }}
    {{ $title := . }}{{ with $logo_image }}{{ $logo_image_resized := (.Fit (printf "70x70 %s" $logo_anchor)) }}{{ end }}{{ $title | html }}
    {{ end }}
33 |           {{ with .Get "subtitle" }}
    {{ . | html }}
    {{ end }}
34 |           
    
35 |             {{ .Inner | markdownify}}
36 |           
    
37 |         
    
38 |       
    
39 |     
    
40 |   
    
41 |   {{ if $byline }}
42 |   
    
43 |     {{ $byline }}
44 |   
    
45 |   {{ end }}
46 | 
    
47 | 


--------------------------------------------------------------------------------
/website/themes/docsy/userguide/content/en/docs/Updating/_index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: "Updating Docsy"
 3 | linkTitle: "Updating Docsy"
 4 | weight: 8
 5 | description: >
 6 |  Keeping the theme up to date.
 7 | ---
 8 | 
 9 | We hope to continue to make improvements to the theme [along with the Docsy community](/docs/contribution-guidelines/). 
10 | If you have cloned the example site (or are otherwise using the theme as a submodule), you can update the Docsy theme
11 | yourself. 
12 | 
13 | Updating Docsy means that your site will build using the latest version of Docsy at `HEAD` and include 
14 | all the new commits or changes that have been merged since the point in time that you initially added the Docsy 
15 | submodule, or last updated. Updating won't affect any modifications that you made in your own project to 
16 | [override the Docsy look and feel](/docs/adding-content/lookandfeel/), as your overrides 
17 | don't modify the theme itself. For details about what has changed in the theme, see the list of 
18 | [Docsy commits](https://github.com/google/docsy/commits/master).
19 | 
20 | Depending on how you chose to use Docsy, follow the corresponding steps to update the theme:
21 | 
22 | ## Update a Docsy submodule
23 | 
24 | If you are using the Docsy theme as a submodule in your project (for example, if you've copied our example site), you update the submodule:
25 | 
26 | 1. Navigate to the root of your local project, then run:
27 | 
28 |         git submodule update --remote
29 | 
30 |     
31 | 1. Add and then commit the change to your project:
32 | 
33 |         git add themes/
34 |         git commit -m "Updating theme submodule"
35 | 
36 | 
37 | 1. Push the commit to your project repo. For example, run:
38 | 
39 |         git push origin master
40 | 
41 |     
42 | ## Update your Docsy clone
43 | 
44 | If you [cloned the Docsy theme](/docs/getting-started/#cloning-the-docsy-theme-to-your-projects-themes-subdirectory) into
45 | the `themes` folder in your project, then you use the `git pull` command:
46 | 
47 | 1. Navigate to the `themes` directory in your local project:
48 | 
49 |         cd themes
50 | 
51 | 1. Ensure that `origin` is set to `https://github.com/google/docsy.git`:
52 | 
53 |         git remote -v
54 | 
55 | 1. Update your local clone:
56 | 
57 |         git pull origin master
58 | 
59 | If you have made any local changes to the cloned theme, you must manually resolve any merge conflicts.
60 | 
61 | 


--------------------------------------------------------------------------------
/website/themes/docsy/assets/js/anchor.js:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Copyright 2018 Google LLC
 3 | 
 4 | Licensed under the Apache License, Version 2.0 (the "License");
 5 | you may not use this file except in compliance with the License.
 6 | You may obtain a copy of the License at
 7 | 
 8 |     https://www.apache.org/licenses/LICENSE-2.0
 9 | 
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 | 
17 | (function ($) {
18 |     'use strict';
19 | 
20 |     // Headers' anchor link that shows on hover
21 |     $(function () {
22 |         // append anchor links to headings in markdown.
23 |         var article = document.getElementsByTagName('main')[0];
24 |         if (!article) {
25 |             return;
26 |         }
27 |         var headings = article.querySelectorAll('h1, h2, h3, h4, h5, h6');
28 |         headings.forEach(function (heading) {
29 |             if (heading.id) {
30 |                 var a = document.createElement('a');
31 |                 // set visibility: hidden, not display: none to avoid layout change
32 |                 a.style.visibility = 'hidden';
33 |                 // [a11y] hide this from screen readers, etc..
34 |                 a.setAttribute('aria-hidden', 'true');
35 |                 // material insert_link icon in svg format
36 |                 a.innerHTML = ' ';
37 |                 a.href = '#' + heading.id;
38 |                 heading.insertAdjacentElement('beforeend', a);
39 |                 heading.addEventListener('mouseenter', function () {
40 |                     a.style.visibility = 'initial';
41 |                 });
42 |                 heading.addEventListener('mouseleave', function () {
43 |                     a.style.visibility = 'hidden';
44 |                 });
45 |             }
46 |         });
47 |     });
48 | 
49 | }(jQuery));
50 | 


--------------------------------------------------------------------------------
/website/static/social/boxed-lf-artwork.svg:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/website/themes/docsy/layouts/_default/list.rss.xml:
--------------------------------------------------------------------------------
 1 | 
 2 |   
 3 |     {{ .Site.Title }} – {{ .Title }}
 4 |     {{ .Permalink }}
 5 |     Recent content {{ if ne  .Title  .Site.Title }}{{ with .Title }}in {{.}} {{ end }}{{ end }}on {{ .Site.Title }}
 6 |     Hugo -- gohugo.io{{ with .Site.LanguageCode }}
 7 |     {{.}}{{end}}{{ with .Site.Author.email }}
 8 |     {{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}{{end}}{{ with .Site.Author.email }}
 9 |     {{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}{{end}}{{ with .Site.Copyright }}
10 |     {{.}}{{end}}{{ if not .Date.IsZero }}
11 |     {{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}{{ end }}
12 |     {{ with .OutputFormats.Get "RSS" }}
13 | 	  {{ printf "" .Permalink .MediaType | safeHTML }}
14 |     {{ end }}
15 |     {{ if not $.Section }}
16 |       {{ $sections := .Site.Params.rss_sections | default (slice "blog") }}
17 |       {{ .Scratch.Set "rss_pages" (first 50 (where $.Site.RegularPages "Type" "in" $sections )) }}
18 |     {{ else }}
19 |       {{ if $.Parent.IsHome }}
20 |         {{ .Scratch.Set "rss_pages" (first 50 (where $.Site.RegularPages "Type" $.Section )) }}
21 |       {{ else }}
22 |         {{ .Scratch.Set "rss_pages" (first 50 $.Pages) }}
23 |       {{ end }}
24 |     {{ end }}
25 |     {{ range (.Scratch.Get "rss_pages")  }}
26 |     
27 |       {{ .Section | title }}: {{ .Title }}
28 |       {{ .Permalink }}
29 |       {{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}
30 |       {{ with .Site.Author.email }}{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}{{end}}
31 |       {{ .Permalink }}
32 |       
33 |         {{ $img := (.Resources.ByType "image").GetMatch "*featured*" }}
34 |         {{ with $img }}
35 |         {{ $img := .Resize "640x" }}
36 |         {{ printf "]]>" $img.Permalink $img.Width $img.Height | safeHTML }}
37 |         {{ end }}
38 |         {{ .Content | html }}
39 |       
40 |     
41 |     {{ end }}
42 |   
43 | 
44 | 


--------------------------------------------------------------------------------
/website/assets/scss/_hamburger.scss:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Hamburger Menu
 3 |  * Based on https://github.com/jonsuh/hamburgers
 4 |  *
 5 |  */
 6 | 
 7 | // Setup variables for the hamburger.
 8 | $hamburger-active-layer-color: $black;
 9 | $hamburger-layer-color: $black;
10 | $hamburger-padding-x: 12px;
11 | $hamburger-padding-y: 0px;
12 | $hamburger-layer-width: 28px;
13 | $hamburger-layer-height: 4px;
14 | $hamburger-layer-spacing: 4px;
15 | $hamburger-hover-opacity: 1;
16 | $hamburger-active-hover-opacity: 1;
17 | 
18 | // Output the hamburger CSS
19 | .hamburger {
20 | 	padding: $hamburger-padding-y $hamburger-padding-x;
21 | 	cursor: pointer;
22 | 
23 | 	transition-property: opacity, filter;
24 | 	transition-duration: 0.15s;
25 | 	transition-timing-function: linear;
26 | 
27 | 	// Normalize the