Nef microsite

.gitignore

@@ -1,3 +1,52 @@
-**/.DS_Store
-**/xcuserdata/
-BowPlayground
+# Created by https://www.gitignore.io/api/android,intellij
+
+# Java class files
+*.class
+
+# Generated files
+bin/
+gen/
+out/
+
+# Gradle files
+.gradle/
+build/
+
+# Local configuration file (sdk path, etc)
+local.properties
+
+# Log Files
+*.log
+
+# Intellij
+.idea/
+reports/
+/out/
+
+KotlinTest
+.kotlintest
+
+# Keystore files
+*.jks
+
+# Google Services (e.g. APIs or Firebase)
+google-services.json
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+## Jekyll
+_site
+.sass-cache
+.jekyll-metadata
+
+## OSX generated
+.DS_Store
+
+## Ruby environment normalization:
+.bundle/
+vendor/
+/lib/bundler/man/

docs/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "jekyll", ">= 3.7.4"

docs/Gemfile.lock

@@ -0,0 +1,63 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.5)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.10.0)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.8.5)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (1.17.0)
+    liquid (4.0.3)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    mercenary (0.3.6)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (3.0.3)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rouge (3.3.0)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll (>= 3.7.4)
+
+BUNDLED WITH
+   1.16.6

docs/_config.yml

@@ -0,0 +1,20 @@
+title: nef
+#-------------------------
+name: nef
+#-------------------------
+description: A set of command line tools that let you have compile time verification of your documentation written as Swift Playground
+#-------------------------
+author: 47 Degrees
+keywords: functional-programming, monads, monad-transformers, functional-data-structure, swift, bow, fp-types, adt, free-monads, tagless-final, mtl, for-comprehension, category-theory
+#-------------------------
+url: https://www.47deg.com
+#-------------------------
+markdown: kramdown
+sass:
+    sass_dir: _sass
+    style: compressed
+#-------------------------
+permalink: pretty
+#-------------------------
+exclude: ['config.ru', 'Gemfile', 'Gemfile.lock', 'vendor', 'Procfile', 'Rakefile']
+#-------------------------

docs/_data/features.yml

@@ -0,0 +1,16 @@
+content:
+    - title: Verification
+      description: Eases the creation of Swift Playgrounds with support for third party libraries.
+      icon: img/main-image-primary.svg
+
+    - title: Compile
+      description: Compiles Swift Playgrounds with support for third party libraries from the command line.
+      icon: img/main-image-secondary.svg
+
+    - title: Generation
+      description: Generates Markdown project from Swift Playground.
+      icon: img/main-image-tertiary.svg
+
+    - title: Integration
+      description: Integrates Swift Playgrounds with Jekyll to create a microsite.
+      icon: img/main-image-quaternary.svg

docs/_data/menu.yml

@@ -0,0 +1,9 @@
+nav:
+    - title: Documentation
+      url: /docs
+
+    - title: Github
+      url: https://github.com/bow-swift/nef
+
+    - title: License
+      url: https://github.com/bow-swift/nef/blob/develop/LICENSE

docs/_data/sidebar.yml

@@ -0,0 +1,12 @@
+options:
+  - title: Verification
+    url: /docs/verification/
+
+  - title: Compile
+    url: /docs/compile/
+
+  - title: Generation
+    url: /docs/generation/
+
+  - title: Integration
+    url: /docs/integration/

docs/_includes/_doc.html

@@ -0,0 +1,14 @@
+<main id="site-doc">
+    <div class="doc-header">
+      <button
+        type="button"
+        class="button doc-toggle"
+        title="Toggle"
+        onClick="toggleClasses(['#site-sidebar', '#site-doc'], ['toggled', 'expanded'])">
+          <img src="{{ site.baseurl }}/img/sidebar-icon-open.svg" alt="Toggle">
+      </button>
+    </div>
+    <div class="doc-content">
+        {{ content }}
+    </div>
+</main>

docs/_includes/_footer.html

@@ -0,0 +1,19 @@
+<div id="site-footer">
+    <div class="wrapper">
+        <div class="footer-flex">
+            <div class="footer-dev">
+                <p>Nef is designed and developed by <a href="https://github.com/bow-swift/nef">{{ site.name }}</a>
+                  with support from <a href="https://www.47deg.com/">47 Degrees</a></p>
+            </div>
+            <ul class="footer-menu">
+                {% for item in site.data.menu.nav %}
+                    <li class="footer-menu-item">
+                      <a href="{{ site.baseurl }}{{ item.url }}" title="{{ item.title }}">
+                        {{ item.title }}
+                      </a>
+                    </li>
+                {% endfor %}
+            </ul>
+        </div>
+    </div>
+</div>

docs/_includes/_head-docs.html

@@ -0,0 +1,29 @@
+<head>
+    <meta charset="UTF-8">
+    <title>{{site.name}}</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="{{site.description}}">
+    <meta name="keywords" content="{{site.keywords}}">
+
+    <meta property="og:image" content="" />
+    <meta property="og:title" content="{{site.name}}" />
+    <meta property="og:site_name" content="{{site.name}}" />
+    <meta property="og:url" content="https://nef.bow-swift.io/" />
+    <meta property="og:type" content="website" />
+    <meta property="og:description" content="{{site.description}}" />
+    <meta property="og:keywords" content="{{site.keywords}}" />
+
+    <meta name="twitter:text:description" content="{{site.description}}" />
+    <meta name="twitter:card" content="summary_large_image">
+    <meta name="twitter:site" content="@bow_swift">
+    <meta name="twitter:creator" content="@bow_swift">
+    <meta name="twitter:image" content="" />
+
+    <script defer src="{{ '/js/docs.js' | relative_url }}"></script>
+
+    <!-- Favicon -->
+    <link rel="shortcut icon" href="{{ '/img/favicon.png' | relative_url }}">
+
+    <!-- Nef docs css -->
+    <link rel="stylesheet" type="text/css" href="{{ '/css/docs.css' | relative_url }}">
+</head>

docs/_includes/_head.html

@@ -0,0 +1,29 @@
+<head>
+    <meta charset="UTF-8">
+    <title>{{site.name}}</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="{{site.description}}">
+    <meta name="keywords" content="{{site.keywords}}">
+
+    <meta property="og:image" content="" />
+    <meta property="og:title" content="{{site.name}}" />
+    <meta property="og:site_name" content="{{site.name}}" />
+    <meta property="og:url" content="https://nef.bow-swift.io/" />
+    <meta property="og:type" content="website" />
+    <meta property="og:description" content="{{site.description}}" />
+    <meta property="og:keywords" content="{{site.keywords}}" />
+
+    <meta name="twitter:text:description" content="{{site.description}}" />
+    <meta name="twitter:card" content="summary_large_image">
+    <meta name="twitter:site" content="@bow_swift">
+    <meta name="twitter:creator" content="@bow_swift">
+    <meta name="twitter:image" content="" />
+
+    <script defer src="{{ '/js/main.js' | relative_url }}"></script>
+
+    <!-- Favicon -->
+    <link rel="shortcut icon" href="{{ '/img/favicon.png' | relative_url }}">
+
+    <!-- Nef main css -->
+    <link rel="stylesheet" type="text/css" href="{{ '/css/styles.css' | relative_url }}">
+</head>

docs/_includes/_header.html

@@ -0,0 +1,13 @@
+<div id="site-header">
+    <div class="wrapper">
+        <div class="header-flex">
+            <div class="header-text">
+                <h1>Compile time verification and generation <span>of documentation from <strong>Swift Playgrounds</strong></span></h1>
+                <a class="header-button" href="{{ site.baseurl }}/docs/" title="Docs">Learn more</a>
+            </div>
+            <div class="header-image">
+                <img src="{{ site.baseurl }}/img/header-image.svg" alt="Nef logo">
+            </div>
+        </div>
+    </div>
+</div>

docs/_includes/_main.html

@@ -0,0 +1,13 @@
+<div id="site-main">
+    <div class="wrapper">
+        <div class="main-flex">
+           {% for item in site.data.features.content %}
+            <div class="main-item">
+                <img src="{{ item.icon }}" alt="{{ item.title }}">
+                <h2>{{ item.title }}</h2>
+                <p>{{ item.description }}</p>
+            </div>
+            {% endfor %}
+        </div>
+    </div>
+</div>

docs/_includes/_nav.html

@@ -0,0 +1,32 @@
+<nav id="site-nav">
+    <div class="wrapper">
+        <div class="nav-flex">
+            <a class="nav-brand" title="Nef" href="{{ site.baseurl }}/">
+                <img src="../img/nav-brand.svg" title="{{ site.name }}">
+                <span>{{ site.name }}</span>
+            </a>
+            <div class="nav-menu">
+                <button
+                  class="button nav-icon-close"
+                  title="Close"
+                  onClick="toggleClass('.nav-menu', 'open');">
+                    <img src="../img/nav-icon-close.svg" alt="Close">
+                </button>
+                <ul>
+                  {% for item in site.data.menu.nav%}
+                  <li class="nav-menu-item">
+                      <a href="{{ item.url }}" title="{{ item.title }}">{{ item.title }}</a>
+                  </li>
+                  {% endfor %}
+                </ul>
+            </div>
+
+            <button
+              class="button nav-icon-open"
+              title="Open"
+              onClick="toggleClass('.nav-menu', 'open');">
+                <img src="../img/nav-icon-open.svg" alt="Open">
+            </button>
+        </div>
+    </div>
+</nav>

docs/_includes/_sidebar.html

@@ -0,0 +1,22 @@
+<div id="site-sidebar">
+    <div class="sidebar-brand">
+        <a href="{{ site.baseurl }}/" title="{{ site.name }}">
+            <img src="{{ site.baseurl }}/img/nav-brand.svg" alt="{{ site.name }}">
+            <span>{{ site.name }}</span>
+        </a>
+        <button
+          type="button"
+          title="Close"
+          class="button sidebar-toggle"
+          onClick="toggleClass('#site-sidebar', 'toggled')">
+            <span class="close"></span>
+        </button>
+    </div>
+    <ul class="sidebar-menu">
+         {% for item in site.data.sidebar.options %}
+        <li class="{% if item.url == page.url %}active{% endif %} sidebar-menu-item">
+            <a href="{{ item.url | relative_url }}" title="{{ item.title }}">{{ item.title }}</a>
+        </li>
+        {% endfor %}
+    </ul>
+</div>

docs/_layouts/docs.html

@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+    {% include _head-docs.html %}
+    <body>
+        {% include _sidebar.html %}
+        {% include _doc.html %}
+    </body>
+</html>

docs/_layouts/home.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+    {% include _head.html %}
+    <body>
+    {% include _nav.html %}
+    {% include _header.html %}
+    {% include _main.html %}
+    {% include _footer.html %}
+    </body>
+</html>