Stub in a jekyll docs site skeleton

aaronlademann-wf · Oct 14, 2016 · 266cc47 · 266cc47
1 parent 972ce7d
commit 266cc47
Show file tree

Hide file tree

Showing 12 changed files with 273 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -26,6 +26,9 @@ nbproject
 *.sublime-workspace
 .idea/*
 
+# Docs ignores
+_site
+
 # Pub ignores
 .pub
 packages

diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'jekyll'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -0,0 +1,45 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    colorator (1.1.0)
+    ffi (1.9.14)
+    forwardable-extended (2.6.0)
+    jekyll (3.3.0)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 3.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (~> 1.7)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.4.0)
+      sass (~> 3.4)
+    jekyll-watch (1.5.0)
+      listen (~> 3.0, < 3.1)
+    kramdown (1.12.0)
+    liquid (3.0.6)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    mercenary (0.3.6)
+    pathutil (0.14.0)
+      forwardable-extended (~> 2.6)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rouge (1.11.1)
+    safe_yaml (1.0.4)
+    sass (3.4.22)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll
+
+BUNDLED WITH
+   1.13.3
diff --git a/_config.yml b/_config.yml
@@ -0,0 +1,43 @@
+# Site settings
+title: OverReact
+description: TODO
+baseurl: ""
+url: "TODO"
+latest_version: 1.0.0
+gacode: "TODO"
+
+# Directories
+source:       .
+destination:  ./_site
+plugins_dir:  docs/_plugins
+layouts_dir:  docs/_layouts
+data_dir:     docs/_data
+includes_dir: docs/_includes
+
+exclude:
+  - integrate
+  - lib
+  - test
+  - tool
+  - packages
+  - docs/sass/bootstrap
+
+# Build settings
+markdown: kramdown
+kramdown:
+  input: GFM
+  syntax_highlighter: rouge
+
+  syntax_highlighter_opts:
+    span:
+      line_numbers: false
+    block:
+      line_numbers: false
+      start_line: 1
+
+sass:
+  style: compressed
+  sass_dir: docs/sass
+
+# Serving
+port: 8020
diff --git a/docs/_includes/site_footer.html b/docs/_includes/site_footer.html
@@ -0,0 +1,23 @@
+<hr class="feature-divider">
+
+<div class="container">
+    <footer class="footer">
+        <div class="footer-left">
+            <span class="footer-item">{{ site.title }}</span>
+            <!-- TODO: Additional links like license, etc. -->
+        </div>
+
+        <div class="footer-right">
+            <!-- TODO: Put something here! -->
+        </div>
+    </footer>
+</div>
+<script>
+    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+    m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+    })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+    ga('create', '{{ site.gacode }}', 'auto');
+    ga('send', 'pageview');
+</script>
diff --git a/docs/_includes/site_navbar.html b/docs/_includes/site_navbar.html
@@ -0,0 +1,24 @@
+<nav class="navbar navbar-static-top navbar-light">
+    <div class="container">
+        <a href="{{site.baseurl}}/">
+            <!-- TODO: Logo -->
+            <!--<img src="" class="navbar-logo">-->
+            <span class="sr-only">{{ site.title }}</span>
+        </a>
+
+        <button class="navbar-toggler hidden-lg-up pull-xs-right" type="button" data-toggle="collapse"
+                data-target="#navbar" aria-controls="exCollapsingNavbar2" aria-expanded="false"
+                aria-label="Toggle navigation">
+        </button>
+
+        <div class="collapse navbar-toggleable-md" id="navbar">
+            <ul class="nav navbar-nav">
+                <!-- TODO: Site Navigation -->
+            </ul>
+
+            <ul class="nav navbar-nav pull-lg-right">
+                <!-- TODO: Secondary Navbar Links -->
+            </ul>
+        </div>
+    </div>
+</nav>
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -0,0 +1,37 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    {% capture description %}{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description | strip_html | strip_newlines }}{% endif %}{% endcapture %}
+
+    <meta property="og:url" content="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}" />
+    <meta property="og:site_name" content="{{ site.title }}" />
+    <meta property="og:title" content="{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}" />
+    <meta property="og:image" content="TODO" />
+    <meta property="og:description" content="{{ description }}" />
+
+    <title>{% if page.title %}{{ page.title }} &middot; {% endif %}{{ site.title }}</title>
+    <meta name="description" content="{{ description }}">
+
+    <link rel="stylesheet" href="{{ site.baseurl }}docs/sass/docs.css?t={{ site.time | date_to_xmlschema }}">
+    <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
+    <link rel="icon" href="{{ site.baseurl }}docs/assets/img/favicon.ico" type="image/x-icon">
+</head>
+<body>
+    {% include site_navbar.html %}
+    {{content}}
+    {% include site_footer.html %}
+
+    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.0/jquery.min.js" integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s=" crossorigin="anonymous"></script>
+    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.3.7/js/tether.min.js" integrity="sha256-/5pHDZh2fv1eZImyfiThtB5Ag4LqDjyittT7fLjdT/8=" crossorigin="anonymous"></script>
+    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.0.0-alpha/js/bootstrap.min.js" integrity="sha256-+h0g0j7qusP72OZaLPCSZ5wjZLnoUUicoxbvrl14WxM=" crossorigin="anonymous"></script>
+    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/holder/2.9.4/holder.min.js" integrity="sha256-ifihHN6L/pNU1ZQikrAb7CnyMBvisKG3SUAab0F3kVU=" crossorigin="anonymous"></script>
+
+    {% for script in page.scripts %}
+        <script type="text/javascript" src="{{script}}"></script>
+    {% endfor %}
+</body>
+</html>
diff --git a/docs/_layouts/home.html b/docs/_layouts/home.html
@@ -0,0 +1,33 @@
+---
+layout: default
+---
+
+<div class="hero">
+    <div class="container">
+        <h1 class="hero-title">
+            yo
+        </h1>
+    </div>
+</div>
+
+<div class="container">
+    <div class="row feature">
+        <div class="col-lg-7">
+            Put some stuff here!
+        </div>
+        <div class="col-lg-5">
+            Maybe an image here?
+        </div>
+    </div>
+
+    <hr class="feature-divider">
+
+    <div class="row feature">
+        <div class="col-lg-7">
+            Another row of stuff... start adding content!
+        </div>
+        <div class="col-lg-5">
+            Maybe an image here?
+        </div>
+    </div>
+</div>
diff --git a/docs/assets/img/favicon.ico b/docs/assets/img/favicon.ico
diff --git a/docs/sass/_variables.scss b/docs/sass/_variables.scss
@@ -0,0 +1,35 @@
+// Workiva palette
+$zc-gray-120: #444444;
+$zc-gray:     #595959;
+$zc-gray-80:  #8a8a8a;
+$zc-gray-40:  #e3e3e3;
+$zc-gray-20:  #f3f3f3;
+$zc-green:    #66cc00;
+$zc-blue:     #0094ff;
+$zc-blue-120: #026dce;
+$zc-orange:   #fbad17;
+$zc-red:      #ee2724;
+
+// Bootstrap palette customization
+$gray-dark:     $zc-gray-120;
+$gray:          $zc-gray;
+$gray-light:    $zc-gray-80;
+$gray-lighter:  $zc-gray-40;
+$gray-lightest: $zc-gray-20;
+
+$brand-primary: $zc-green;
+$brand-success: $zc-green;
+$brand-info:    $zc-blue;
+$brand-warning: $zc-orange;
+$brand-danger:  $zc-red;
+
+$body-color: $gray;
+$link-color: $zc-blue-120;
+$link-hover-color: $zc-blue;
+
+// Bootstrap options
+$enable-flex: true;
+$enable-transitions: true;
+
+$font-family-sans-serif: "Helvetica Neue", Helvetica, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Arial, sans-serif;
+$font-family-monospace: Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
diff --git a/docs/sass/docs.scss b/docs/sass/docs.scss
@@ -0,0 +1,24 @@
+---
+---
+
+@charset "utf-8";
+
+/*!
+ * -------------------------------------
+ * over_react documentation styles
+ * -------------------------------------
+ */
+
+
+//
+// Variables, mixins, functions, etc.
+// (No CSS generated)
+//
+@import 'variables';
+
+
+//
+// CSS styles
+//
+@import 'bootstrap/scss/bootstrap';
+
diff --git a/index.html b/index.html
@@ -0,0 +1,3 @@
+---
+layout: home
+---