github-docs 0.0.1

data/_sass/primer-utilities/typography.scss

@@ -0,0 +1,215 @@
+// stylelint-disable block-closing-brace-space-before, primer/selector-no-utility, selector-list-comma-newline-after
+// stylelint-disable comment-empty-line-before
+// Type scale variables found in primer-support/lib/variables.scss
+// $h00-size-mobile: 40px;
+// $h0-size-mobile: 32px;
+// $h1-size-mobile: 26px;
+// $h2-size-mobile: 22px;
+// $h3-size-mobile: 18px;
+// $h00-size: 48px;
+// $h0-size: 40px;
+// $h1-size: 32px;
+// $h2-size: 24px;
+// $h3-size: 20px;
+// $h4-size: 16px;
+// $h5-size: 14px;
+// $h6-size: 12px;
+
+/* Set the font size to 26px */
+.h1 {
+  font-size: $h1-size-mobile !important;
+
+  @include breakpoint(md) { font-size: $h1-size !important; }
+}
+
+/* Set the font size to 22px */
+.h2 {
+  font-size: $h2-size-mobile !important;
+
+  @include breakpoint(md) { font-size: $h2-size !important; }
+}
+
+/* Set the font size to 18px */
+.h3 {
+  font-size: $h3-size-mobile !important;
+
+  @include breakpoint(md) { font-size: $h3-size !important; }
+}
+
+/* Set the font size to #{$h4-size} */
+.h4 {
+  font-size: $h4-size !important;
+}
+
+/* Set the font size to #{$h5-size} */
+.h5 { font-size: $h5-size !important; }
+
+// Does not include color property like typography base
+// styles, color should be applied with color utilities.
+/* Set the font size to #{$h6-size} */
+.h6 { font-size: $h6-size !important; }
+
+// Heading utilities
+.h1, .h2, .h3, .h4, .h5, .h6 { font-weight: $font-weight-bold !important; }
+
+// Type utilities that match type sale
+/* Set the font size to 26px */
+.f1 {
+  font-size: $h1-size-mobile !important;
+
+  @include breakpoint(md) { font-size: $h1-size !important; }
+}
+
+/* Set the font size to 22px */
+.f2 {
+  font-size: $h2-size-mobile !important;
+
+  @include breakpoint(md) { font-size: $h2-size !important; }
+}
+
+/* Set the font size to 18px */
+.f3 {
+  font-size: $h3-size-mobile !important;
+
+  @include breakpoint(md) { font-size: $h3-size !important; }
+}
+
+/* Set the font size to #{$h4-size} */
+.f4 {
+  font-size: $h4-size !important;
+
+  @include breakpoint(md) { font-size: $h4-size !important; }
+}
+
+/* Set the font size to #{$h5-size} */
+.f5 { font-size: $h5-size !important; }
+/* Set the font size to #{$h6-size} */
+.f6 { font-size: $h6-size !important; }
+
+// Type utils with light weight that match type scale
+/* Set the font size to 40px and weight to light */
+.f00-light {
+  font-size: $h00-size-mobile !important;
+  font-weight: $font-weight-light !important;
+
+  @include breakpoint(md) { font-size: $h00-size !important; }
+}
+
+/* Set the font size to 32px and weight to light */
+.f0-light {
+  font-size: $h0-size-mobile !important;
+  font-weight: $font-weight-light !important;
+
+  @include breakpoint(md) { font-size: $h0-size !important; }
+}
+
+/* Set the font size to 26px and weight to light */
+.f1-light {
+  font-size: $h1-size-mobile !important;
+  font-weight: $font-weight-light !important;
+
+  @include breakpoint(md) { font-size: $h1-size !important; }
+}
+
+/* Set the font size to 22px and weight to light */
+.f2-light {
+  font-size: $h2-size-mobile !important;
+  font-weight: $font-weight-light !important;
+
+  @include breakpoint(md) { font-size: $h2-size !important; }
+}
+
+// Same size and weight as .lead but without color property
+/* Set the font size to 18px and weight to light */
+.f3-light {
+  font-size: $h3-size-mobile !important;
+  font-weight: $font-weight-light !important;
+
+  @include breakpoint(md) { font-size: $h3-size !important; }
+}
+
+// Smallest text size
+/* Set the font size to ${#h6-size} */
+.text-small { font-size: $h6-size !important; } // 12px
+
+/* Large leading paragraphs */
+.lead {
+  margin-bottom: 30px;
+  font-size: $h3-size;
+  font-weight: $font-weight-light;
+  color: $gray-600;
+}
+
+// Line-height variations
+// Close to commonly used line-heights. Most line-heights
+// combined with type size equate to whole pixels.
+// Will be improved with future typography scale updates.
+/* Set the line height to ultra condensed */
+.lh-condensed-ultra { line-height: $lh-condensed-ultra !important; }
+/* Set the line height to condensed */
+.lh-condensed { line-height: $lh-condensed !important; }
+/* Set the line height to default */
+.lh-default { line-height: $lh-default !important; }
+/* Set the line height to zero */
+.lh-0 { line-height: 0 !important; }
+
+// Text alignments
+// Responsive text alignment
+@each $breakpoint, $variant in $responsive-variants {
+  @include breakpoint($breakpoint) {
+    /* Text align to the right */
+    .text#{$variant}-right { text-align: right !important; }
+    /* Text align to the left */
+    .text#{$variant}-left { text-align: left !important; }
+    /* Text align to the center */
+    .text#{$variant}-center { text-align: center !important; }
+  }
+}
+
+// Text styles
+/* Set the font weight to normal */
+.text-normal { font-weight: $font-weight-normal !important; }
+/* Set the font weight to bold */
+.text-bold { font-weight: $font-weight-bold !important;}
+/* Set the font to italic */
+.text-italic { font-style: italic !important; }
+/* Make text uppercase */
+.text-uppercase { text-transform: uppercase !important; }
+/* Underline text */
+.text-underline { text-decoration: underline !important; }
+/* Don't underline text */
+.no-underline { text-decoration: none !important; }
+/* Don't wrap white space */
+.no-wrap { white-space: nowrap !important; }
+/* Normal white space */
+.ws-normal { white-space: normal !important; }
+/* Allow long lines with no spaces to line break */
+.wb-break-all { word-break: break-all !important; }
+
+.text-emphasized {
+  font-weight: $font-weight-bold;
+  color: $text-gray-dark;
+}
+
+// List styles
+.list-style-none { list-style: none !important; }
+
+// Text Shadows
+/* Add a dark text shadow */
+.text-shadow-dark {
+  text-shadow: 0 1px 1px rgba($black, 0.25), 0 1px 25px rgba($black, 0.75);
+}
+/* Add a light text shadow */
+.text-shadow-light {
+  text-shadow: 0 1px 0 rgba($white, 0.5);
+}
+
+/* Set to monospace font */
+.text-mono {
+  font-family: $mono-font;
+}
+
+/* Disallow user from selecting text */
+.user-select-none {
+  user-select: none !important;
+}

data/_sass/primer-utilities/visibility-display.scss

@@ -0,0 +1,87 @@
+// Visibility and display utilities
+// stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before, primer/selector-no-utility
+// stylelint-disable comment-empty-line-before
+
+$display-values: (
+  block,
+  flex,
+  inline,
+  inline-block,
+  inline-flex,
+  none,
+  table,
+  table-cell
+);
+
+// Responsive display utilities
+@each $breakpoint, $variant in $responsive-variants {
+  @include breakpoint($breakpoint) {
+    @each $display in $display-values {
+      .d#{$variant}-#{$display} { display: $display !important; }
+    }
+  }
+}
+
+.v-hidden { visibility: hidden !important; }
+.v-visible { visibility: visible !important; }
+
+// Hide utilities for each breakpoint
+// Each hide utility only applies to one breakpoint range.
+@media (max-width: $width-sm) {
+  .hide-sm {
+    display: none !important;
+  }
+}
+
+@media (min-width: $width-sm) and (max-width: $width-md) {
+  .hide-md {
+    display: none !important;
+  }
+}
+
+@media (min-width: $width-md) and (max-width: $width-lg) {
+  .hide-lg {
+    display: none !important;
+  }
+}
+
+@media (min-width: $width-lg) {
+  .hide-xl {
+    display: none !important;
+  }
+}
+
+/* Set the table-layout to fixed */
+.table-fixed { table-layout: fixed !important; }
+
+// Only display content to screen readers
+//
+// See: http://a11yproject.com/posts/how-to-hide-content/
+.sr-only {
+  position: absolute;
+  width: 1px;
+  height: 1px;
+  padding: 0;
+  overflow: hidden;
+  clip: rect(0, 0, 0, 0);
+  // Workaround for https://bugzilla.mozilla.org/show_bug.cgi?id=1241631
+  word-wrap: normal;
+  border: 0;
+}
+
+// Only display content on focus
+.show-on-focus {
+  position: absolute;
+  width: 1px;
+  height: 1px;
+  margin: 0;
+  overflow: hidden;
+  clip: rect(1px, 1px, 1px, 1px);
+
+  &:focus {
+    z-index: 20;
+    width: auto;
+    height: auto;
+    clip: auto;
+  }
+}

data/_sass/rouge.scss

@@ -0,0 +1,209 @@
+.highlight table td { padding: 5px; }
+.highlight table pre { margin: 0; }
+.highlight .cm {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .cp {
+  color: #999999;
+  font-weight: bold;
+}
+.highlight .c1 {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .cs {
+  color: #999999;
+  font-weight: bold;
+  font-style: italic;
+}
+.highlight .c, .highlight .cd {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .err {
+  color: #a61717;
+  background-color: #e3d2d2;
+}
+.highlight .gd {
+  color: #000000;
+  background-color: #ffdddd;
+}
+.highlight .ge {
+  color: #000000;
+  font-style: italic;
+}
+.highlight .gr {
+  color: #aa0000;
+}
+.highlight .gh {
+  color: #999999;
+}
+.highlight .gi {
+  color: #000000;
+  background-color: #ddffdd;
+}
+.highlight .go {
+  color: #888888;
+}
+.highlight .gp {
+  color: #555555;
+}
+.highlight .gs {
+  font-weight: bold;
+}
+.highlight .gu {
+  color: #aaaaaa;
+}
+.highlight .gt {
+  color: #aa0000;
+}
+.highlight .kc {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kd {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kn {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kp {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kr {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kt {
+  color: #445588;
+  font-weight: bold;
+}
+.highlight .k, .highlight .kv {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .mf {
+  color: #009999;
+}
+.highlight .mh {
+  color: #009999;
+}
+.highlight .il {
+  color: #009999;
+}
+.highlight .mi {
+  color: #009999;
+}
+.highlight .mo {
+  color: #009999;
+}
+.highlight .m, .highlight .mb, .highlight .mx {
+  color: #009999;
+}
+.highlight .sb {
+  color: #d14;
+}
+.highlight .sc {
+  color: #d14;
+}
+.highlight .sd {
+  color: #d14;
+}
+.highlight .s2 {
+  color: #d14;
+}
+.highlight .se {
+  color: #d14;
+}
+.highlight .sh {
+  color: #d14;
+}
+.highlight .si {
+  color: #d14;
+}
+.highlight .sx {
+  color: #d14;
+}
+.highlight .sr {
+  color: #009926;
+}
+.highlight .s1 {
+  color: #d14;
+}
+.highlight .ss {
+  color: #990073;
+}
+.highlight .s {
+  color: #d14;
+}
+.highlight .na {
+  color: #008080;
+}
+.highlight .bp {
+  color: #999999;
+}
+.highlight .nb {
+  color: #0086B3;
+}
+.highlight .nc {
+  color: #445588;
+  font-weight: bold;
+}
+.highlight .no {
+  color: #008080;
+}
+.highlight .nd {
+  color: #3c5d5d;
+  font-weight: bold;
+}
+.highlight .ni {
+  color: #800080;
+}
+.highlight .ne {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nf {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nl {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nn {
+  color: #555555;
+}
+.highlight .nt {
+  color: #000080;
+}
+.highlight .vc {
+  color: #008080;
+}
+.highlight .vg {
+  color: #008080;
+}
+.highlight .vi {
+  color: #008080;
+}
+.highlight .nv {
+  color: #008080;
+}
+.highlight .ow {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .o {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .w {
+  color: #bbbbbb;
+}
+.highlight {
+  background-color: #f8f8f8;
+}

data/assets/css/index.scss

@@ -0,0 +1,16 @@
+---
+# this ensures Jekyll reads the file to be transformed into CSS later
+# only Main files contain this front matter, not partials.
+---
+
+{% if site.logo %}
+  $logo: "{{ site.logo | absolute_url }}";
+{% endif %}
+
+@import "primer-support/index.scss";
+@import "primer-base/index.scss";
+@import "primer-utilities/index.scss";
+@import "primer-layout/index.scss";
+@import "primer-markdown/index.scss";
+@import "github-docs";
+@import "rouge";

data/assets/imgs/back.svg

@@ -0,0 +1 @@
+<svg preserveAspectRatio="xMidYMid meet" height="1em" width="1em" fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" stroke="currentColor" class="icon-7f6730be--text-3f89f380"><g><line x1="19" y1="12" x2="5" y2="12"></line><polyline points="12 19 5 12 12 5"></polyline></g></svg>

data/assets/js/anchor.min.js

@@ -0,0 +1,6 @@
+/**
+ * AnchorJS - v4.1.0 - 2017-09-20
+ * https://github.com/bryanbraun/anchorjs
+ * Copyright (c) 2017 Bryan Braun; Licensed MIT
+ */
+!function(A,e){"use strict";"function"==typeof define&&define.amd?define([],e):"object"==typeof module&&module.exports?module.exports=e():(A.AnchorJS=e(),A.anchors=new A.AnchorJS)}(this,function(){"use strict";return function(A){function e(A){A.icon=A.hasOwnProperty("icon")?A.icon:"",A.visible=A.hasOwnProperty("visible")?A.visible:"hover",A.placement=A.hasOwnProperty("placement")?A.placement:"right",A.ariaLabel=A.hasOwnProperty("ariaLabel")?A.ariaLabel:"Anchor",A.class=A.hasOwnProperty("class")?A.class:"",A.truncate=A.hasOwnProperty("truncate")?Math.floor(A.truncate):64}function t(A){var e;if("string"==typeof A||A instanceof String)e=[].slice.call(document.querySelectorAll(A));else{if(!(Array.isArray(A)||A instanceof NodeList))throw new Error("The selector provided to AnchorJS was invalid.");e=[].slice.call(A)}return e}function i(){if(null===document.head.querySelector("style.anchorjs")){var A,e=document.createElement("style");e.className="anchorjs",e.appendChild(document.createTextNode("")),void 0===(A=document.head.querySelector('[rel="stylesheet"], style'))?document.head.appendChild(e):document.head.insertBefore(e,A),e.sheet.insertRule(" .anchorjs-link {   opacity: 0;   text-decoration: none;   -webkit-font-smoothing: antialiased;   -moz-osx-font-smoothing: grayscale; }",e.sheet.cssRules.length),e.sheet.insertRule(" *:hover > .anchorjs-link, .anchorjs-link:focus  {   opacity: 1; }",e.sheet.cssRules.length),e.sheet.insertRule(" [data-anchorjs-icon]::after {   content: attr(data-anchorjs-icon); }",e.sheet.cssRules.length),e.sheet.insertRule(' @font-face {   font-family: "anchorjs-icons";   src: url(data:n/a;base64,AAEAAAALAIAAAwAwT1MvMg8yG2cAAAE4AAAAYGNtYXDp3gC3AAABpAAAAExnYXNwAAAAEAAAA9wAAAAIZ2x5ZlQCcfwAAAH4AAABCGhlYWQHFvHyAAAAvAAAADZoaGVhBnACFwAAAPQAAAAkaG10eASAADEAAAGYAAAADGxvY2EACACEAAAB8AAAAAhtYXhwAAYAVwAAARgAAAAgbmFtZQGOH9cAAAMAAAAAunBvc3QAAwAAAAADvAAAACAAAQAAAAEAAHzE2p9fDzz1AAkEAAAAAADRecUWAAAAANQA6R8AAAAAAoACwAAAAAgAAgAAAAAAAAABAAADwP/AAAACgAAA/9MCrQABAAAAAAAAAAAAAAAAAAAAAwABAAAAAwBVAAIAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAMCQAGQAAUAAAKZAswAAACPApkCzAAAAesAMwEJAAAAAAAAAAAAAAAAAAAAARAAAAAAAAAAAAAAAAAAAAAAQAAg//0DwP/AAEADwABAAAAAAQAAAAAAAAAAAAAAIAAAAAAAAAIAAAACgAAxAAAAAwAAAAMAAAAcAAEAAwAAABwAAwABAAAAHAAEADAAAAAIAAgAAgAAACDpy//9//8AAAAg6cv//f///+EWNwADAAEAAAAAAAAAAAAAAAAACACEAAEAAAAAAAAAAAAAAAAxAAACAAQARAKAAsAAKwBUAAABIiYnJjQ3NzY2MzIWFxYUBwcGIicmNDc3NjQnJiYjIgYHBwYUFxYUBwYGIwciJicmNDc3NjIXFhQHBwYUFxYWMzI2Nzc2NCcmNDc2MhcWFAcHBgYjARQGDAUtLXoWOR8fORYtLTgKGwoKCjgaGg0gEhIgDXoaGgkJBQwHdR85Fi0tOAobCgoKOBoaDSASEiANehoaCQkKGwotLXoWOR8BMwUFLYEuehYXFxYugC44CQkKGwo4GkoaDQ0NDXoaShoKGwoFBe8XFi6ALjgJCQobCjgaShoNDQ0NehpKGgobCgoKLYEuehYXAAAADACWAAEAAAAAAAEACAAAAAEAAAAAAAIAAwAIAAEAAAAAAAMACAAAAAEAAAAAAAQACAAAAAEAAAAAAAUAAQALAAEAAAAAAAYACAAAAAMAAQQJAAEAEAAMAAMAAQQJAAIABgAcAAMAAQQJAAMAEAAMAAMAAQQJAAQAEAAMAAMAAQQJAAUAAgAiAAMAAQQJAAYAEAAMYW5jaG9yanM0MDBAAGEAbgBjAGgAbwByAGoAcwA0ADAAMABAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAH//wAP) format("truetype"); }',e.sheet.cssRules.length)}}this.options=A||{},this.elements=[],e(this.options),this.isTouchDevice=function(){return!!("ontouchstart"in window||window.DocumentTouch&&document instanceof DocumentTouch)},this.add=function(A){var n,o,s,a,r,c,h,l,u,d,f,p=[];if(e(this.options),"touch"===(f=this.options.visible)&&(f=this.isTouchDevice()?"always":"hover"),A||(A="h2, h3, h4, h5, h6"),0===(n=t(A)).length)return this;for(i(),o=document.querySelectorAll("[id]"),s=[].map.call(o,function(A){return A.id}),r=0;r<n.length;r++)if(this.hasAnchorJSLink(n[r]))p.push(r);else{if(n[r].hasAttribute("id"))a=n[r].getAttribute("id");else if(n[r].hasAttribute("data-anchor-id"))a=n[r].getAttribute("data-anchor-id");else{u=l=this.urlify(n[r].textContent),h=0;do{void 0!==c&&(u=l+"-"+h),c=s.indexOf(u),h+=1}while(-1!==c);c=void 0,s.push(u),n[r].setAttribute("id",u),a=u}a.replace(/-/g," "),(d=document.createElement("a")).className="anchorjs-link "+this.options.class,d.href="#"+a,d.setAttribute("aria-label",this.options.ariaLabel),d.setAttribute("data-anchorjs-icon",this.options.icon),"always"===f&&(d.style.opacity="1"),""===this.options.icon&&(d.style.font="1em/1 anchorjs-icons","left"===this.options.placement&&(d.style.lineHeight="inherit")),"left"===this.options.placement?(d.style.position="absolute",d.style.marginLeft="-1em",d.style.paddingRight="0.5em",n[r].insertBefore(d,n[r].firstChild)):(d.style.paddingLeft="0.375em",n[r].appendChild(d))}for(r=0;r<p.length;r++)n.splice(p[r]-r,1);return this.elements=this.elements.concat(n),this},this.remove=function(A){for(var e,i,n=t(A),o=0;o<n.length;o++)(i=n[o].querySelector(".anchorjs-link"))&&(-1!==(e=this.elements.indexOf(n[o]))&&this.elements.splice(e,1),n[o].removeChild(i));return this},this.removeAll=function(){this.remove(this.elements)},this.urlify=function(A){var t=/[& +$,:;=?@"#{}|^~[`%!'<>\]\.\/\(\)\*\\]/g;return this.options.truncate||e(this.options),A.trim().replace(/\'/gi,"").replace(t,"-").replace(/-{2,}/g,"-").substring(0,this.options.truncate).replace(/^-+|-+$/gm,"").toLowerCase()},this.hasAnchorJSLink=function(A){var e=A.firstChild&&(" "+A.firstChild.className+" ").indexOf(" anchorjs-link ")>-1,t=A.lastChild&&(" "+A.lastChild.className+" ").indexOf(" anchorjs-link ")>-1;return e||t||!1}}});

data/assets/js/index.js

@@ -0,0 +1,52 @@
+window.gdocs = {
+
+  eventAdd: function(el, type, handler) {
+    if (el.attachEvent) el.attachEvent('on' + type, handler)
+    else el.addEventListener(type, handler)
+  },
+
+  eventRemove: function(el, type, handler) {
+    if (el.detachEvent) el.detachEvent('on' + type, handler)
+    else el.removeEventListener(type, handler)
+  },
+
+  init: function() {
+    gdocs.nav()
+    document.querySelector('.content').focus()
+  },
+
+  onReady: function() {
+    // in case the document is already rendered
+    if (document.readyState!='loading') {
+      gdocs.init()
+      
+    // modern browsers
+    } else if (document.addEventListener) {
+      document.addEventListener('DOMContentLoaded', gdocs.init)
+    }
+  },
+
+  nav: function() {
+    // Show/hide mobile menu
+    var body = document.querySelector('body')
+    var navElems = document.getElementsByClassName('toggle-nav')
+
+    for (var i=navElems.length; i--;) {
+      gdocs.eventAdd(navElems[i], 'click', function(e) {
+        e.preventDefault()
+        var text = this.innerText
+        var textToggle = this.getAttribute('data-text-toggle')
+
+        body.classList.toggle('nav-open')
+        this.classList.toggle('nav-open')
+        if (textToggle) {
+          this.innerText = textToggle
+          this.setAttribute('data-text-toggle', text)
+          textToggle = text
+        }
+      })
+    }
+  }
+}
+
+gdocs.onReady()

data/readme.md

@@ -0,0 +1,34 @@
+# Github docs
+
+A Jekyll theme for Github styled documentation
+
+### Github pages usage
+
+Just add this line to your _config.yml file:
+```yaml
+theme: jekyll-theme-primer
+```
+
+### Preview jekyll theme locally
+
+Add the following to your site's Gemfile:
+```ruby
+gem "github-docs"
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install github-docs
+```
+
+### Development
+
+1. `$ gem install bundler`
+2. `$ bundle install` (install theme deps)
+3. `$ bundle exec` (build files)
+3. `$ jekyll serve`