github-docs 0.0.5 → 0.0.18

data/_sass/primer-markdown/index.scss

@@ -1,4 +1,115 @@
-@import "./markdown-body.scss";
+
+$markdown-line-height: 1.5em;
+$markdown-spacer-1: 4px;
+$markdown-spacer-2: 8px;
+$markdown-spacer-3: 16px;
+$markdown-spacer-4: 24px;
+$markdown-font-size-small: 12px;
+$markdown-font-weight-bold: 600;
+
+$gray-000: #fafbfc;
+$gray-100: #f6f8fa;
+$gray-200: #e1e4e8;
+$gray-300: #d1d5da;
+$gray-400: #959da5;
+$gray-500: #6a737d;
+$gray-700: #444d56;
+
+.markdown-body {
+  font-size: 16px;
+  line-height: $markdown-line-height;
+  word-wrap: break-word;
+  color: #24292e;
+  &::after {
+    display: block;
+    clear: both;
+    content: "";
+  }
+  > *:first-child {
+    margin-top: 0 !important;
+  }
+  > *:last-child {
+    margin-bottom: 0 !important;
+  }
+  // Blocks
+  p,
+  blockquote,
+  ul,
+  ol,
+  dl,
+  table,
+  pre,
+  .highlight {
+    margin-top: 0;
+    margin-bottom: $markdown-spacer-3;
+  }
+  hr {
+    height: 0.25em;
+    padding: 0;
+    margin: $markdown-spacer-4 0;
+    background-color: $gray-200;
+    border: 0;
+  }
+  blockquote {
+    margin-left: 0;
+    margin-right: 0;
+    padding: 0 1em;
+    color: $gray-500;
+    border-left: 0.25em solid lighten($gray-300, 5%);
+    > :first-child {
+      margin-top: 0;
+    }
+    > :last-child {
+      margin-bottom: 0;
+    }
+  }
+  kbd {
+    display: inline-block;
+    padding: 3px 5px;
+    font-size: 11px;
+    line-height: 10px;
+    color: $gray-700;
+    vertical-align: middle;
+    background-color: $gray-000;
+    border: solid 1px darken($gray-300, 4%);
+    border-bottom-color: $gray-400;
+    border-radius: 3px;
+    box-shadow: inset 0 -1px 0 $gray-400;
+  }
+  // Anchors like <a name="examples">. These sometimes end up wrapped around
+  // text when users mistakenly forget to close the tag or use self-closing tag
+  // syntax. We don't want them to appear like links.
+  a {
+    color: #0366d6;
+    text-decoration: none;
+    &:hover,
+    &:focus {
+      text-decoration: underline;
+    }
+  }
+  a:not([href]) {
+    color: inherit;
+    text-decoration: none;
+  }
+  // Links
+  .absent {
+    color: #cb2431;
+  }
+  .anchor,
+  .anchorjs-link  {
+    float: left;
+    line-height: 1em;
+    font-size: 1.1em !important;
+    padding-right: 10px !important;
+    margin-left: calc(-1em - 10px) !important;
+    &:hover,
+    &:focus {
+      outline: none;
+      text-decoration: none;
+    }
+  }
+}
+
 @import "./headings.scss";
 @import "./lists.scss";
 @import "./tables.scss";

data/_sass/primer-markdown/lists.scss

@@ -1,42 +1,12 @@
-// Base styles
-// stylelint-disable selector-no-qualifying-type
-// stylelint-disable selector-max-type
 .markdown-body {
-
-  // Lists, Blockquotes & Such
   ul,
   ol {
     padding-left: 2em;
-
     &.no-list {
       padding: 0;
       list-style-type: none;
     }
   }
-
-  // Did someone complain about list spacing? Encourage them
-  // to create the spacing with their markdown formatting.
-  // List behavior should be controled by the markup, not the css.
-  //
-  // For lists with padding between items, use blank
-  // lines between items. This will generate paragraphs with
-  // padding to space things out.
-  //
-  // - item
-  //
-  // - item
-  //
-  // - item
-  //
-  // For list without padding, don't use blank lines.
-  //
-  // - item
-  // - item
-  // - item
-  //
-  // Modifying the css to emulate these behaviors merely brakes
-  // one case in the process of solving another. Don't change
-  // this unless it's really really a bug.
   ul ul,
   ul ol,
   ol ol,
@@ -44,33 +14,29 @@
     margin-top: 0;
     margin-bottom: 0;
   }
-
   li {
     word-wrap: break-all;
   }
-
   li > p {
-    margin-top: $spacer-3;
+    margin-top: $markdown-spacer-3;
   }
-
   li + li {
-    margin-top: $em-spacer-3;
+    margin-top: 0.25em;
   }
-
   dl {
     padding: 0;
-
     dt {
+      margin: 0;
       padding: 0;
-      margin-top: $spacer-3;
+      margin-top: $markdown-spacer-3;
       font-size: 1em;
       font-style: italic;
-      font-weight: $font-weight-bold;
+      font-weight: $markdown-font-weight-bold;
     }
-
     dd {
-      padding: 0 $spacer-3;
-      margin-bottom: $spacer-3;
+      margin: 0;
+      padding: 0 $markdown-spacer-3;
+      margin-bottom: $markdown-spacer-3;
     }
   }
 }

data/_sass/primer-markdown/tables.scss

@@ -6,26 +6,21 @@
     display: block;
     width: 100%;
     overflow: auto;
-
-    th {
-      font-weight: $font-weight-bold;
-    }
-
     th,
     td {
       padding: 6px 13px;
       border: 1px solid lighten($gray-300, 5%);
     }
-
+    th {
+      font-weight: $markdown-font-weight-bold;
+    }
     tr {
-      background-color: $bg-white;
+      background-color: #fff;
       border-top: 1px solid darken($gray-300, 4%);
-
       &:nth-child(2n) {
         background-color: $gray-100;
       }
     }
-
     img {
       background-color: transparent;
     }

data/_sass/rouge.scss

@@ -1,5 +1,12 @@
-.highlight table td { padding: 5px; }
-.highlight table pre { margin: 0; }
+.highlight {
+  background-color: #f8f8f8;
+  table td {
+    padding: 5px;
+  }
+  table pre {
+    margin: 0;
+  }
+}
 .highlight .cm {
   color: #999988;
   font-style: italic;
@@ -17,7 +24,8 @@
   font-weight: bold;
   font-style: italic;
 }
-.highlight .c, .highlight .cd {
+.highlight .c,
+.highlight .cd {
   color: #999988;
   font-style: italic;
 }
@@ -82,7 +90,8 @@
   color: #445588;
   font-weight: bold;
 }
-.highlight .k, .highlight .kv {
+.highlight .k,
+.highlight .kv {
   color: #000000;
   font-weight: bold;
 }
@@ -101,7 +110,9 @@
 .highlight .mo {
   color: #009999;
 }
-.highlight .m, .highlight .mb, .highlight .mx {
+.highlight .m,
+.highlight .mb,
+.highlight .mx {
   color: #009999;
 }
 .highlight .sb {
@@ -204,6 +215,3 @@
 .highlight .w {
   color: #bbbbbb;
 }
-.highlight {
-  background-color: #f8f8f8;
-}

data/assets/css/index.scss

@@ -2,15 +2,17 @@
 # this ensures Jekyll reads the file to be transformed into CSS later
 # only Main files contain this front matter, not partials.
 ---
+@charset "utf-8";
 
 {% 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";
+// Cherry variables
+$body-font-size: 14px;
+$body-line-height: 1.65em;
+$family-primary: -apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,
+  "Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
+
+// Load modules
+@import "primer-markdown", "cherry", "main", "rouge";

data/readme.md

@@ -13,12 +13,21 @@ A Jekyll theme for Github styled documentation
 
 1. To preview this theme in your project via `github-pages`, add a Gemfile in your root folder
     ```ruby
+    # (old)
+    # source 'https://rubygems.org'
+    # gem 'github-pages', group: :jekyll_plugins
+
+    # Below pulls the latest remote_theme in development
+    # https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages
     source 'https://rubygems.org'
-    gem 'github-pages', group: :jekyll_plugins
+    gem "github-docs", git: "https://github.com/boycce/github-docs"
+    group :jekyll_plugins do
+      gem "jekyll-remote-theme", "~> 0.4.2"
+    end
     ```
 2. Then update `github-pages` and the `theme`
     ```
-    $ bundle update
+    $ bundle install // or bundle update
     ```
 3. And run
     ```
@@ -28,8 +37,8 @@ A Jekyll theme for Github styled documentation
 ### Development
 
 1. Install rvm/ruby `^2.7.3` if not having done so already
-2. `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)
-3. `$ bundle install` (install theme deps automatically)
+2. (a) `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)
+3. (b) `$ bundle install` (install theme deps automatically)
 4. `$ jekyll serve`
 
 ### Publishing Gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-docs
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.18
 platform: ruby
 authors:
 - Ricky Boyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,46 +92,30 @@ files:
 - _layouts/home.html
 - _layouts/page.html
 - _layouts/post.html
-- _sass/github-docs.scss
-- _sass/primer-base/base.scss
-- _sass/primer-base/index.scss
-- _sass/primer-base/normalize.scss
-- _sass/primer-base/typography-base.scss
-- _sass/primer-layout/columns.scss
-- _sass/primer-layout/container.scss
-- _sass/primer-layout/grid-offset.scss
-- _sass/primer-layout/grid.scss
-- _sass/primer-layout/index.scss
+- _sass/cherry/_base-normalize.scss
+- _sass/cherry/_buttons.scss
+- _sass/cherry/_columns.scss
+- _sass/cherry/_elements.scss
+- _sass/cherry/_forms-vue-select.scss
+- _sass/cherry/_forms.scss
+- _sass/cherry/_functions.scss
+- _sass/cherry/_index.scss
+- _sass/cherry/_layout.scss
+- _sass/cherry/_modal.scss
+- _sass/cherry/_spacing.scss
+- _sass/cherry/_tooltips.scss
+- _sass/cherry/_typography.scss
+- _sass/cherry/_utilities.scss
+- _sass/cherry/_variables-computed.scss
+- _sass/cherry/_variables.scss
+- _sass/main.scss
 - _sass/primer-markdown/blob-csv.scss
 - _sass/primer-markdown/code.scss
 - _sass/primer-markdown/headings.scss
 - _sass/primer-markdown/images.scss
 - _sass/primer-markdown/index.scss
 - _sass/primer-markdown/lists.scss
-- _sass/primer-markdown/markdown-body.scss
 - _sass/primer-markdown/tables.scss
-- _sass/primer-support/index.scss
-- _sass/primer-support/mixins/buttons.scss
-- _sass/primer-support/mixins/layout.scss
-- _sass/primer-support/mixins/misc.scss
-- _sass/primer-support/mixins/typography.scss
-- _sass/primer-support/variables/color-system.scss
-- _sass/primer-support/variables/colors.scss
-- _sass/primer-support/variables/layout.scss
-- _sass/primer-support/variables/misc.scss
-- _sass/primer-support/variables/typography.scss
-- _sass/primer-utilities/animations.scss
-- _sass/primer-utilities/borders.scss
-- _sass/primer-utilities/box-shadow.scss
-- _sass/primer-utilities/colors.scss
-- _sass/primer-utilities/details.scss
-- _sass/primer-utilities/flexbox.scss
-- _sass/primer-utilities/index.scss
-- _sass/primer-utilities/layout.scss
-- _sass/primer-utilities/margin.scss
-- _sass/primer-utilities/padding.scss
-- _sass/primer-utilities/typography.scss
-- _sass/primer-utilities/visibility-display.scss
 - _sass/rouge.scss
 - assets/css/index.scss
 - assets/imgs/back.svg

data/_sass/primer-base/base.scss

@@ -1,84 +0,0 @@
-// stylelint-disable selector-max-type
-* {
-  box-sizing: border-box;
-}
-
-input,
-select,
-textarea,
-button {
-  font-family: inherit;
-  font-size: inherit;
-  line-height: inherit;
-}
-
-body {
-  font-family: $body-font;
-  font-size: $body-font-size;
-  line-height: $body-line-height;
-  color: $text-gray-dark;
-  background-color: $bg-white;
-}
-
-a {
-  color: $text-blue;
-  text-decoration: none;
-
-  &:hover {
-    text-decoration: underline;
-  }
-}
-
-b,
-strong {
-  font-weight: $font-weight-bold;
-}
-
-// Horizontal lines
-//
-// TODO-MDO: Remove `.rule` from everywhere and replace with `<hr>`s
-hr,
-.rule {
-  height: 0;
-  margin: 15px 0;
-  overflow: hidden;
-  background: transparent;
-  border: 0;
-  border-bottom: 1px solid lighten($gray-300, 5%);
-  @include clearfix();
-}
-
-//
-// Remove most spacing between table cells.
-//
-
-table {
-  border-spacing: 0;
-  border-collapse: collapse;
-}
-
-td,
-th {
-  padding: 0;
-}
-
-button {
-  cursor: pointer;
-  // Remove border radius added by Chroma macOS
-  border-radius: 0;
-}
-
-// increase the selector specificity for [hidden]
-// so that it always overrides utility classes (.d-block, etc.)
-[hidden][hidden] {
-  display: none !important;
-}
-
-details {
-  summary { cursor: pointer; }
-
-  &:not([open]) {
-    // Set details content hidden by default for browsers that don't do this
-    > *:not(summary) { display: none !important; }
-  }
-}