bytewax-docs 0.1.0

data/_config.yml

@@ -0,0 +1,84 @@
+# Global site settings
+title: bytewax
+url: https://docs.bytewax.io
+author: bytewax
+email: konrad@sienkowski.eu
+language: en
+
+# Global site description, added to HEAD section if page/post description is not specified
+description: bytewax - no infra, only code
+
+# Keywords related to your site's content (for SEO purposes)
+keywords: bytewax, machine, learning, ai, ml, inference
+
+# Configure brand settings (logo, icons, default mobile theme colour)
+logo: 'assets/img/logo.svg'
+logo-reverse: 'assets/img/logo_yellow.svg'
+logo-monochrome: 'assets/img/logo_mono.svg'
+logo-dark: 'assets/img/logo_white.svg'
+favicon: '/assets/img/favicon.png'
+
+# Suggest a colour for mobile browsers to use as the browser's theme. This is only supported by a few mobile browsers.
+mobile-theme-col: '#FAB90F'
+
+# Specify path to global og:image (for social media sharing)
+og-image: '/assets/img/og-image.png'
+
+# Fill in your Google Analytics ID to track your website using Google Analytics (_includes/google_analytics.html)
+# google_analytics: "G-06HTJPTC44"
+
+# Default excerpt word length - truncate the post excerpt to the specified number of words
+excerpt-length: 20
+
+# Add collections for custom content
+collections:
+  docs:
+    output: true
+  tutorials:
+    output: true
+
+# Default YAML values (more information on Jekyll's site)
+defaults:
+  - scope:
+      path: 'assets/img'
+    values:
+      image: true-
+  - scope:
+      type: pages
+      path: _pages
+    values:
+      is_post: false
+  - scope:
+      type: docs
+      path: _docs
+    values:
+      layout: docs
+      permalink: /:slugified_categories/:title/
+  - scope:
+      type: tutorials
+      path: _tutorials
+    values:
+      layout: tutorial
+      permalink: /tutorials/:title/
+
+# Include additional folders
+include:
+ - _pages
+ - .htaccess
+
+# Exclude these files from production site
+exclude:
+  - .sass-cache/
+  - .jekyll-cache/
+  - gemfiles/
+  - Gemfile
+  - Gemfile.lock
+  - bytewax-docs.gemspec
+  - bytewax-docs-0.1.0.gem
+  - node_modules/
+  - gulpfile.js
+  - README.md
+  - vendor/bundle/
+  - vendor/cache/
+  - vendor/gems/
+  - vendor/ruby/

data/_data/categories.yml

@@ -0,0 +1,3 @@
+# Specify custom order of categories (Docs)
+order:
+ - Sample category

data/_data/cookies.yml

@@ -0,0 +1,10 @@
+# Cookie consent settings
+  display: true
+  # How many days takes for cookie of the popup to reset  
+  expire: 28 
+  content: > 
+    This website uses cookies to provide services at the highest level. You can change cookie settings (including their blocking) in your browser settings at any time. 
+    By continuing to use the site, you agree to their use.
+  link:
+    title: Privacy policy
+    url: /privacy-policy/

data/_data/footer.yml

@@ -0,0 +1,14 @@
+copyright: Copyright 2021 by Bytewax, Inc. All rights reserved
+
+widgets:
+  - title: Resources
+    nav: 
+      - page: Documentation
+        url: /
+      - page: Tutorials
+        url: /tutorials/
+
+  - title: Legal
+    nav: 
+      - page: Privacy policy
+        url: /privacy-policy/

data/_data/navbar.yml

@@ -0,0 +1,17 @@
+nav:
+- title: Home
+  url: /
+  button: false
+
+- title: Resources
+  url: #
+  dropdown:
+    - page: Docs
+      url: /
+    - page: Tutorials
+      url: /tutorials/
+  button: false
+
+- title: Contact Us
+  url: https://www.bytewax.io/contact-us/
+  button: true

data/_docs/another-article.md

@@ -0,0 +1,19 @@
+---
+title: Another article
+category: Sample category
+order: 0
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean ut mauris eu est ultricies congue at id ante. Nam sodales finibus bibendum. Ut sit amet nunc sem.
+
+## Headline 2
+
+Vivamus sagittis tincidunt eleifend. Cras in euismod erat. Duis nisi tortor, eleifend in tincidunt laoreet, lacinia sit amet metus. Nullam nunc augue, luctus eget tortor ac, venenatis bibendum augue. In hac habitasse platea dictumst. Phasellus rhoncus sagittis bibendum. Proin mattis, felis quis tempus iaculis, lorem quam efficitur justo, eget eleifend augue neque ac justo. Praesent eget lacinia leo, eu imperdiet enim. Sed blandit felis vitae maximus scelerisque.
+
+### Headline 3
+
+Maecenas sollicitudin hendrerit elementum. Nulla porta libero sed accumsan lobortis. Vivamus quis urna porta nisi pulvinar aliquam sed a risus. Donec interdum turpis non nisi consectetur, ut rutrum nisl dictum. Etiam viverra interdum justo vitae cursus.
+
+## Yet another H2 tag
+
+Morbi in ex laoreet, tempus ex at, ornare lectus. Nulla a nisi fermentum, volutpat sapien eu, fringilla nibh. Vestibulum eget tempor nulla.

data/_docs/sample-article.md

@@ -0,0 +1,19 @@
+---
+title: Sample article
+category: Sample category
+order: -1
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean ut mauris eu est ultricies congue at id ante. Nam sodales finibus bibendum. Ut sit amet nunc sem.
+
+## Headline 2
+
+Vivamus sagittis tincidunt eleifend. Cras in euismod erat. Duis nisi tortor, eleifend in tincidunt laoreet, lacinia sit amet metus. Nullam nunc augue, luctus eget tortor ac, venenatis bibendum augue. In hac habitasse platea dictumst. Phasellus rhoncus sagittis bibendum. Proin mattis, felis quis tempus iaculis, lorem quam efficitur justo, eget eleifend augue neque ac justo. Praesent eget lacinia leo, eu imperdiet enim. Sed blandit felis vitae maximus scelerisque.
+
+### Headline 3
+
+Maecenas sollicitudin hendrerit elementum. Nulla porta libero sed accumsan lobortis. Vivamus quis urna porta nisi pulvinar aliquam sed a risus. Donec interdum turpis non nisi consectetur, ut rutrum nisl dictum. Etiam viverra interdum justo vitae cursus.
+
+## Yet another H2 tag
+
+Morbi in ex laoreet, tempus ex at, ornare lectus. Nulla a nisi fermentum, volutpat sapien eu, fringilla nibh. Vestibulum eget tempor nulla.

data/_includes/alert.html

@@ -0,0 +1,4 @@
+<div class="alert alert--{{ include.type }}" role="alert">
+    <i class="alert__icon">{{ include.icon }}</i>
+    <p class="alert__content">{{ include.content }}</p>
+</div>

data/_includes/cookie-consent.html

@@ -0,0 +1,13 @@
+{% if site.data.cookies.display %}
+    <div class="cookie-consent" data-expire="{{ site.data.cookies.expire | default: 14 }}">
+        <div class="cookie-consent__content">
+            {{ site.data.cookies.content }} 
+            <a href="{{ site.data.cookies.link.url }}" class="cookie-consent__link">
+                {{ site.data.cookies.link.title }}
+            </a>
+        </div>
+        <button class="cookie-consent__button btn btn--md btn--primary">
+            I agree
+        </button>
+    </div>
+{% endif %}

data/_includes/docs/pagination.html

@@ -0,0 +1,28 @@
+{% if page.categories %}
+    {% assign currentCat = page.categories[0] %}
+    {% assign links = site.docs | sort: 'order' | where: 'category', currentCat %}
+{% endif %}
+
+{% for link in links %}
+    {% if link.title == page.title %}
+        {% unless forloop.first %}
+            {% assign prev = tmpprev %}
+        {% endunless %}
+        {% unless forloop.last %}
+            {% assign next = links[forloop.index] %}
+        {% endunless %}
+    {% endif %}
+    {% assign tmpprev = link %}
+{% endfor %}
+<nav class="docs__pagination">
+	{% if prev %}
+        <a class="docs__pagination-item docs__pagination-item--prev" href="{{ prev.url}}" title="{{ prev.title }}">
+            {{ prev.title }}
+        </a>
+    {% endif %}
+	{% if next %}
+        <a class="docs__pagination-item docs__pagination-item--next" href="{{ next.url}}">
+            {{ next.title }}
+        </a>
+    {% endif %}
+</nav>

data/_includes/docs/sidebar.html

@@ -0,0 +1,42 @@
+<aside class="docs__sidebar">
+    <!-- Search -->
+    <div class="docs__search">
+        <input id="search-input" class="docs__search-input" type="search" placeholder="Search docs…" autocomplete="off">
+        <ul class="docs__search-results" id="results-container"></ul>
+    </div>
+
+    <!-- Nav -->
+    {% assign docs_by_category = site.docs | group_by: 'category' %}
+    <ul class="docs__nav">
+        {% for cat in site.data.categories.order %}
+            {% assign currentCat = docs_by_category | where: 'name', cat | first %}
+            {% assign currPath = page.path | split: "/" %}
+            {% assign catSlug =  currentCat.name | slugify %}
+            {% if page.url == '/' and forloop.first == true %}
+                <li class="docs__nav-item--active">
+            {% elsif currPath[1] == catSlug %}
+                <li class="docs__nav-item--active">
+            {% else %}
+                <li class="docs__nav-item">
+            {% endif %}
+                    <a class="docs__nav-toggle">{{ currentCat.name}}</a>
+                    <ul class="docs__nav-dropdown">
+                        {% assign docs = site.docs | where: 'category', currentCat.name | sort: 'order' %}
+                        {% assign sortedDocs = site.docs | sort: 'order' %}
+                        {% for entry in docs %}
+                            {% if page.url == entry.url or page.url == "/" and sortedDocs[0].title == entry.title %}
+                                <li class="docs__nav-dropdown-item docs__nav-dropdown-item--active">
+                                    <a href="{{ entry.url }}" class="docs__nav-dropdown-link">{{ entry.title }}</a>
+                                </li>
+                            {% else %}
+                                <li class="docs__nav-dropdown-item">
+                                    <a href="{{ entry.url }}" class="docs__nav-dropdown-link">{{ entry.title }}</a>
+                                </li>
+                            {% endif %}
+                        {% endfor %}
+                    </ul>
+                </li>
+        {% endfor %}
+    </ul>
+
+</aside>

data/_includes/docs/toc.html

@@ -0,0 +1,4 @@
+<aside class="docs__toc">
+    <h5 class="docs__toc-title h4">In this section</h5>
+    <ul class="docs__toc-list"></ul>
+</aside>

data/_includes/footer.html

@@ -0,0 +1,36 @@
+<!-- Footer -->
+<footer class="footer">
+    <div class="footer__container container row">
+        <div class="footer__copyright">
+            {% if site.logo %}
+                <img class="footer__logo" src="{{ site.logo | relative_url}}" alt="{{ site.title }}">
+            {% endif %}
+            {% if site.logo-monochrome %}
+                <img class="footer__logo--mono" src="{{ site.logo-monochrome | relative_url}}" alt="{{ site.title }}">
+            {% endif %}
+            {% if site.logo-dark %}
+                <img class="footer__logo--dark" src="{{ site.logo-dark | relative_url}}" alt="{{ site.title }}">
+            {% endif %}
+            <p>&copy; {{ site.data.footer.copyright }}</p>
+        </div>
+        {% for item in site.data.footer.widgets %}
+            <div class="footer__widget footer__widget--{{ item.title | downcase }}">
+                <h5 class="footer__widget-title">
+                    {{ item.title }}
+                </h5>
+                {% if item.nav[0] %}
+                    <ul class="footer__nav">
+                        {% for entry in item.nav %}
+                        <li class="footer__nav-item">
+                            <a class="footer__nav-link" href="{{ entry.url }}">{{ entry.page }}</a>
+                        </li>
+                        {% endfor %}
+                    </ul>
+                {% endif %}
+            </div>
+        {% endfor %}
+    </div>
+</footer>
+
+<!-- Scripts -->
+<script src="{{ 'assets/js/scripts.min.js' | relative_url}}"></script>

data/_includes/google_analytics.html

@@ -0,0 +1,12 @@
+{% if site.google_analytics %}
+    <!-- Global site tag (gtag.js) - Google Analytics -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
+    <script>
+        window.dataLayer = window.dataLayer || [];
+        function gtag(){dataLayer.push(arguments);}
+        gtag('js', new Date());
+
+        gtag('config', '{{ site.google_analytics }}');
+    </script>
+    <!-- End Google Analytics -->
+{% endif %}

data/_includes/head.html

@@ -0,0 +1,73 @@
+<head>
+	<meta charset="utf-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+	<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ '/feed.xml' | absolute_url }}">
+	
+	{% capture title %}
+		{% if page.title %}
+			{{ page.title | strip_html | xml_escape }} – {{ site.title | strip_html | xml_escape }}
+		{% else %}
+			{{ site.title | strip_html | xml_escape }}
+		{% endif %}
+	{% endcapture %}
+	<title>{{ title }}</title>
+
+	<meta property="og:title" content="{{ title }}">
+	<meta property="twitter:title" content="{{ title }}">
+
+	{% capture description %}
+		{% if page.description %}
+			{{ page.description | strip_html | xml_escape }}
+		{% elsif page.is_post %}
+			{{ page.content | strip_html | xml_escape | truncatewords: 50 }}
+		{% else %}
+			{{ site.description | strip_html | xml_escape }}
+		{% endif %}
+	{% endcapture %}
+
+	<meta name="description" content="{{ description }}">
+	<meta property="og:description" content="{{ description }}">
+	<meta property="twitter:description" content="{{ description }}">
+
+	{% if page.is_post %}
+		{% assign author = site.data.team[page.author] %}
+		<meta property="og:type" content="article">
+		<meta property="og:article:author" content="{{ author.name }}">
+		<meta property="og:article:published_time" content="{{ page.date | date_to_xmlschema }}">
+		<meta property="og:url" content="{{ page.url | absolute_url }}">
+		{% if page.featured-image %}
+			<meta property="og:image" content="{{ page.featured-image | absolute_url }}">
+  			<meta name="twitter:image" content="{{ page.featured-image | absolute_url }}">
+		{% endif %}
+		<link rel="canonical" href="{{ page.url | absolute_url }}">
+	{% else %}
+		<meta property="og:type" content="website">
+		<meta property="og:url" content="{{ page.url | absolute_url | strip_index }}">
+		{% if site.og-image %}
+			<meta property="og:image" content="{{ site.og-image | absolute_url }}">
+		{% endif %}
+		<link rel="canonical" href="{{ page.url | absolute_url | strip_index }}">
+	{% endif %}
+
+	{% if site.keywords %}
+		<meta name="keywords" content="{{ site.keywords }}">
+	{% endif %}
+
+	{% if site.mobile-theme-col %}
+		<meta name="theme-color" content="{{ site.mobile-theme-col }}">
+	{% endif %}
+
+	{% if site.title %}
+		<meta property="og:site_name" content="{{ site.title }}">
+	{% endif %}
+
+	<!-- Stylesheet -->
+	<link rel="stylesheet" href="{{ '/assets/css/main.css' | relative_url }}">
+
+	{% if site.favicon %}
+		<link rel="icon" href="{{ site.favicon | relative_url }}">
+	{% endif %}
+
+	<!-- Google Analytics -->
+	{% include google_analytics.html %}
+</head>

data/_includes/navbar.html

@@ -0,0 +1,57 @@
+<!-- Navbar -->
+<nav class="navbar">
+    <div class="navbar__container container">
+        <!-- Brand -->
+        <a class="navbar__brand" href="{{ '/' | relative_url}}">
+            {% if site.logo %}
+                <img class="navbar__logo" src="{{ site.logo | relative_url}}" alt="{{ site.title }}">
+            {% endif %}
+            {% if site.logo-reverse %}
+                <img class="navbar__logo--yellow" src="{{ site.logo-reverse | relative_url}}" alt="{{ site.title }}">
+            {% endif %}
+            {% if site.logo-dark %}
+                <img class="navbar__logo--dark" src="{{ site.logo-dark | relative_url}}" alt="{{ site.title }}">
+            {% endif %}
+        </a>
+
+        <!-- Toggle navigation (tablet & mobile) -->
+        <button class="navbar__toggler">
+            <span></span>
+            <span></span>
+            <span></span>
+        </button>
+
+        <!-- Navigation -->
+        <ul class="navbar__nav">
+            {% for item in site.data.navbar.nav %}
+                {% if item.button %}
+                    <li class="navbar__nav-item navbar__nav-item--btn">
+                        <a class="navbar__nav-btn" href="{{ item.url }}">{{ item.title }}</a>
+                    </li>
+                {% else %}
+                    {% if page.url == item.url %}
+                    <li class="navbar__nav-item navbar__nav-item--active">
+                    {% else %}
+                    <li class="navbar__nav-item">
+                    {% endif %}
+                        {% if item.dropdown[0] %}
+                            <a class="navbar__nav-link navbar__nav-link--dropdown" href="#">{{ item.title }}</a>
+                        {% else %}
+                            <a class="navbar__nav-link" href="{{ item.url }}">{{ item.title }}</a>
+                        {% endif %}
+                        {% if item.dropdown[0] %}
+                            <ul class="navbar__nav-dropdown">
+                                {% for entry in item.dropdown %}
+                                <li class="navbar__nav-dropdown-item">
+                                    <a class="navbar__nav-dropdown-link" href="{{ entry.url }}">{{ entry.page }}</a>
+                                </li>
+                                {% endfor %}
+                            </ul>
+                        {% endif %}
+                    </li>
+                {% endif %}
+            {% endfor %} 
+        </ul>
+        <button class="navbar__switch navbar__switch--light" id="switchColorMode"></button>
+    </div>
+</nav>