Skip to content

Commit

Permalink
Initial docs site commit / testing for gh-pages branch
Browse files Browse the repository at this point in the history
Squashed commit of the following:

commit 6b35e07
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Wed Oct 19 15:24:25 2016 -0700

    Stub in dart / react component demo files

commit 83e5e4d
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Wed Oct 19 15:01:21 2016 -0700

    Allow scripts in head and body

commit 4c656e7
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Wed Oct 19 13:09:39 2016 -0700

    Update some docs urls

commit d3a9074
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Tue Oct 18 13:00:51 2016 -0700

    DOCS: Add home page content

commit 2648fc5
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Tue Oct 18 07:51:00 2016 -0700

    DOCS: Don’t write custom styles using bs classes

commit a1b0caa
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Tue Oct 18 07:38:36 2016 -0700

    DOCS: Improve inline svg accessibility

commit 3b76751
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Tue Oct 18 07:33:58 2016 -0700

    DOCS: Use SVG for navbar brand name

    + Otherwise we’re at the mercy of the font within the stack that the user’s system actually has, which can cause the text size to vary a great deal.

commit 287a58c
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Tue Oct 18 06:59:39 2016 -0700

    Improve docs site footer

    + Add workiva W symbol
    + Tweak item spacing
    + Add link to license

commit ad994f8
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Tue Oct 18 06:58:49 2016 -0700

    Make inline svgs accessible

commit 6216610
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Mon Oct 17 08:28:31 2016 -0700

    Add Google Analytics tracking code for docs site

commit 0f668b5
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Fri Oct 14 16:17:19 2016 -0700

    Update logo

commit 7d60803
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Fri Oct 14 16:08:21 2016 -0700

    Add home / misc page layouts and styles

commit 2d75b68
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Fri Oct 14 10:10:47 2016 -0700

    Add brand assets

commit 266cc47
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Thu Oct 13 16:46:42 2016 -0700

    Stub in a jekyll docs site skeleton

commit 972ce7d
Author: Aaron Lademann <aaron.lademann@workiva.com>
Date:   Thu Oct 13 15:26:19 2016 -0700

    Add twbs submodule

    + So we can build some docs!
  • Loading branch information
aaronlademann-wf committed Oct 20, 2016
1 parent a09b274 commit a0b9497
Show file tree
Hide file tree
Showing 55 changed files with 1,086 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ nbproject
*.sublime-workspace
.idea/*

# Docs ignores
_site

# Pub ignores
.pub
packages
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs/sass/bootstrap"]
path = docs/sass/bootstrap
url = git@github.com:twbs/bootstrap.git
3 changes: 3 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
source 'https://rubygems.org'

gem 'jekyll'
45 changes: 45 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -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
57 changes: 57 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Site settings
title: OverReact
pkg_name: over_react
description: A framework for building statically-typed React UI components using Dart.
latest_version: 1.0.0
gacode: "UA-17703918-81"

# Directories
permalink: pretty
source: .
destination: ./_site
plugins_dir: docs/_plugins
layouts_dir: docs/_layouts
data_dir: docs/_data
includes_dir: docs/_includes

exclude:
- 'integrate'
- 'lib'
- 'test'
- 'tool'
- '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: expanded
sass_dir: docs/sass

# Serving
baseurl: "/"
url: "TODO"
port: 8020

# Misc
org_url: https://www.workiva.com
org_target: wk

org_repos_url: https://github.com/Workiva
repo_url: https://github.com/Workiva/over_react
license_url: https://github.com/Workiva/over_react/blob/master/LICENSE
repo_target: github

api_target: dartdocs
reactjs_target: reactjs
dartlang_target: dartlang
7 changes: 7 additions & 0 deletions demos.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Demo Components
lead: We should really type something else here, to help the peoples with the understanding.
layout: page
slug: demos
baseurl: ../
---
9 changes: 9 additions & 0 deletions demos/list-group/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: ListGroup Component Demo
lead: We should really type something else here, to help the peoples with the understanding.
layout: demo
slug: list-group
parent_slug: demos
baseurl: ../../
dart_src: ../../web/demos/list-group/index.dart
---
1 change: 1 addition & 0 deletions docs/_includes/content-placeholder-bg-mask-empty-line.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include content-placeholder-bg-mask.html spacer=true %}
17 changes: 17 additions & 0 deletions docs/_includes/content-placeholder-bg-mask.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{% assign hasCustomOffset = false %}
{% assign lOffsetStyle = '' %}
{% assign rOffsetStyle = '' %}
{% assign style = '' %}
{% if include.lOffset %}
{% assign hasCustomOffset = true %}
{% capture lOffsetStyle %}left: {{ include.lOffset }};{% endcapture %}
{% endif %}
{% if include.rOffset %}
{% assign hasCustomOffset = true %}
{% capture rOffsetStyle %}right: {{ include.rOffset }};{% endcapture %}
{% endif %}
{% if hasCustomOffset %}
{% capture style %} style="{{lOffsetStyle}}{{rOffsetStyle}}"{% endcapture %}
{% endif %}
<div class="content-placeholder__bg-mask bg-mask--line bg-mask--line-{{maskLine}}"{{ style }}></div>{% if include.spacer %}
<div class="content-placeholder__bg-mask bg-mask--spacer bg-mask--spacer-{{maskLine}}"></div>{% endif %}
9 changes: 9 additions & 0 deletions docs/_includes/favicons.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<link rel="apple-touch-icon" sizes="180x180" href="{{ page.baseurl }}docs/assets/img/apple-touch-icon.png">
<link rel="icon" type="image/png" href="{{ page.baseurl }}docs/assets/img/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="{{ page.baseurl }}docs/assets/img/favicon-16x16.png" sizes="16x16">
<link rel="icon" type="image/x-icon" href="{{ page.baseurl }}docs/assets/img/favicon.ico">
<link rel="shortcut icon" href="{{ page.baseurl }}docs/assets/img/favicon.ico">
<link rel="manifest" href="{{ page.baseurl }}docs/assets/img/manifest.json">
<link rel="mask-icon" href="{{ page.baseurl }}docs/assets/img/safari-pinned-tab.svg" color="#00d2b8">
<meta name="msapplication-config" content="{{ page.baseurl }}docs/assets/img/browserconfig.xml">
<meta name="theme-color" content="#ffffff">
38 changes: 38 additions & 0 deletions docs/_includes/home-code-content-placeholder-lines.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<div class="content-placeholder__bg-masks-container">
{% assign maskLine = 0 %}
{% include content-placeholder-bg-mask.html lOffset='30%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask.html lOffset='60%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask-empty-line.html spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask.html lOffset='20%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask.html lOffset='70%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask-empty-line.html spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask.html lOffset='40%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask.html lOffset='60%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask.html rOffset='80%' %}
{% include content-placeholder-bg-mask.html lOffset='80%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask-empty-line.html spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask.html rOffset='90%' %}
{% include content-placeholder-bg-mask.html lOffset='40%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask.html rOffset='90%' %}
{% include content-placeholder-bg-mask.html lOffset='70%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask-empty-line.html spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask.html rOffset='95%' %}
{% include content-placeholder-bg-mask.html lOffset='10%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
{% include content-placeholder-bg-mask.html lOffset='5%' spacer=true %}
{% assign maskLine = maskLine | plus: 1 %}
<div class="content-placeholder__bg-mask bg-mask--line-{{ maskLine }} bg-mask--cap-bottom"></div>
</div>
37 changes: 37 additions & 0 deletions docs/_includes/site_footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{% include site_vars.html %}
<hr class="footer-divider">

<div class="container">
<footer class="footer row">
<div class="footer__col footer__col--left col-md">
<div class="d-flex flex-items-xs-middle">
{% include svg/workiva-symbol.svg class="footer__logo" %}
<span>
{{ site.title }} is brought to you by the good folks at
<a href="{{ site.org_url }}" target="{{ site.org_target }}">Workiva</a>
</span>
</div>
</div>
<div class="footer__col footer__col--right col-md col-sm-shrink d-flex flex-items-xs-middle">
<div class="d-flex flex-items-xs-middle">
<ul class="footer__items">
<li class="footer__item">
<a class="footer__link" href="{{ site.license_url }}" target="{{ site.repo_target }}">License</a>
</li>
<li class="footer__item">
<a class="footer__link" href="{{ site.repo_url }}" target="{{ site.repo_target }}">Github</a>
</li>
</ul>
</div>
</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>
39 changes: 39 additions & 0 deletions docs/_includes/site_navbar.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{% include site_vars.html %}
<nav class="navbar navbar-static-top navbar-light">
<div class="container">
<div class="row">
<div class="col-xs col-xs-shrink pl-0">
<a class="navbar-brand d-flex flex-items-xs-middle" href="{{page.baseurl}}">
{% include svg/over_react-logo.svg class="navbar__logo" %}
</a>
</div>
<div class="col-xs pr-0 text-xs-right flex-items-xs-right hidden-sm-up">
<button class="navbar-toggler" type="button"
data-toggle="collapse"
data-target="#site-navigation"
aria-controls="site-navigation"
aria-expanded="false"
aria-label="Toggle navigation">
</button>
</div>
<div class="col-sm pr-0">
<div class="collapse navbar-toggleable-xs" id="site-navigation">
<ul class="nav navbar-nav">
<li class="nav-item{% if page.parent_slug == 'demos' or page.slug == 'demos' %} active{% endif %}">
<a class="nav-link" href="{{page.baseurl}}/demos/">Demos</a>
</li>
<li class="nav-item">
<a class="nav-link" href="{{ dartdocs_url }}/index.html" target="{{ site.api_target }}">API Docs</a>
</li>
</ul>

<ul class="nav navbar-nav float-sm-right">
<li class="nav-item">
<a class="nav-link" href="{{ site.repo_url }}" target="{{ site.repo_target }}">Github</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</nav>
1 change: 1 addition & 0 deletions docs/_includes/site_vars.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% capture dartdocs_url %}https://www.dartdocs.org/documentation/{{ site.pkg_name }}/{{ site.latest_version }}{% endcapture %}
9 changes: 9 additions & 0 deletions docs/_includes/svg/dart-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a0b9497

Please sign in to comment.