github-docs 0.0.3 → 0.0.7

data/{_sass/primer-markdown/markdown-body.scss → assets/css/primer-markdown/index.scss}

@@ -1,95 +1,67 @@
-// All of our block level items should have the same margin
-// stylelint-disable selector-max-type
+$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;
 
-// This is styling for generic markdownized text. Anything you put in a
-// container with .markdown-body on it should render generally well. It also
-// includes some GitHub Flavored Markdown specific styling (like @mentions)
 .markdown-body {
-  font-family: $body-font;
-  font-size: $h4-size;
-  line-height: $body-line-height;
+  font-size: 16px;
+  line-height: $markdown-line-height;
   word-wrap: break-word;
-
-  // Clearfix on the markdown body
-  &::before {
-    display: table;
-    content: "";
-  }
-
+  color: #24292e;
   &::after {
-    display: table;
+    display: block;
     clear: both;
     content: "";
   }
-
   > *:first-child {
     margin-top: 0 !important;
   }
-
   > *:last-child {
     margin-bottom: 0 !important;
   }
-
-  // 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.
-  // FIXME: a:not(:link):not(:visited) would be a little clearer here (and
-  // possibly faster to match), but it breaks styling of <a href> elements due
-  // to https://bugs.webkit.org/show_bug.cgi?id=142737.
-  a:not([href]) {
-    color: inherit;
-    text-decoration: none;
-  }
-
-  // Link Colors
-  .absent {
-    color: $red-600;
-  }
-
-  .anchor {
-    float: left;
-    padding-right: $spacer-1;
-    margin-left: -20px;
-    line-height: $lh-condensed-ultra;
-
-    &:focus {
-      outline: none;
-    }
-  }
-
+  // Blocks
   p,
   blockquote,
   ul,
   ol,
   dl,
   table,
-  pre {
+  pre,
+  .highlight {
     margin-top: 0;
-    margin-bottom: $spacer-3;
+    margin-bottom: $markdown-spacer-3;
   }
-
   hr {
-    height: $em-spacer-3;
+    height: 0.25em;
     padding: 0;
-    margin: $spacer-4 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;
@@ -103,4 +75,43 @@
     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";
+@import "./images.scss";
+@import "./code.scss";
+@import "./blob-csv.scss";

data/assets/css/primer-markdown/lists.scss

@@ -0,0 +1,42 @@
+.markdown-body {
+  ul,
+  ol {
+    padding-left: 2em;
+    &.no-list {
+      padding: 0;
+      list-style-type: none;
+    }
+  }
+  ul ul,
+  ul ol,
+  ol ol,
+  ol ul {
+    margin-top: 0;
+    margin-bottom: 0;
+  }
+  li {
+    word-wrap: break-all;
+  }
+  li > p {
+    margin-top: $markdown-spacer-3;
+  }
+  li + li {
+    margin-top: 0.25em;
+  }
+  dl {
+    padding: 0;
+    dt {
+      margin: 0;
+      padding: 0;
+      margin-top: $markdown-spacer-3;
+      font-size: 1em;
+      font-style: italic;
+      font-weight: $markdown-font-weight-bold;
+    }
+    dd {
+      margin: 0;
+      padding: 0 $markdown-spacer-3;
+      margin-bottom: $markdown-spacer-3;
+    }
+  }
+}

data/{_sass → assets/css}/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 → assets/css}/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/readme.md

@@ -4,34 +4,33 @@ A Jekyll theme for Github styled documentation
 
 ### Theme usage
 
-Add a _config.yml file with this line:
-```yaml
-theme: github-docs
-```
-
-### 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
-```
+1. To use this theme in your project via `github-pages`, add a _config.yml file with this line
+    ```yaml
+    remote_theme: boycce/github-docs
+    ```
+
+### Theme preview
+
+1. To preview this theme in your project via `github-pages`, add a Gemfile in your root folder
+    ```ruby
+    source 'https://rubygems.org'
+    gem 'github-pages', group: :jekyll_plugins
+    ```
+2. Then update `github-pages` and the `theme`
+    ```
+    $ bundle update
+    ```
+3. And run
+    ```
+    $ bundle exec jekyll serve
+    ```
 
 ### Development
 
-1. `$ gem install bundler`
-2. `$ bundle install` (install theme deps)
-3. `$ bundle exec` (build files)
-3. `$ jekyll serve`
+1. Install rvm/ruby `^2.7.3` if not having done so already
+2.a. `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)
+2.b. `$ bundle install` (install theme deps automatically)
+4. `$ jekyll serve`
 
 ### Publishing Gem
 

metadata

@@ -1,91 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: github-docs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.7
 platform: ruby
 authors:
 - Ricky Boyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.5'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 3.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.5'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: jekyll-github-metadata
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: 2.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: jekyll-seo-tag
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.7.1
 - !ruby/object:Gem::Dependency
-  name: jekyll-target-blank
+  name: kramdown-parser-gfm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.1.0
 description: 
 email:
 - example@email.com
@@ -98,48 +92,32 @@ 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/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/cherry/_base-normalize.scss
+- assets/css/cherry/_buttons.scss
+- assets/css/cherry/_columns.scss
+- assets/css/cherry/_elements.scss
+- assets/css/cherry/_forms-vue-select.scss
+- assets/css/cherry/_forms.scss
+- assets/css/cherry/_functions.scss
+- assets/css/cherry/_index.scss
+- assets/css/cherry/_layout.scss
+- assets/css/cherry/_modal.scss
+- assets/css/cherry/_spacing.scss
+- assets/css/cherry/_tooltips.scss
+- assets/css/cherry/_typography.scss
+- assets/css/cherry/_utilities.scss
+- assets/css/cherry/_variables-computed.scss
+- assets/css/cherry/_variables.scss
 - assets/css/index.scss
+- assets/css/main.scss
+- assets/css/primer-markdown/blob-csv.scss
+- assets/css/primer-markdown/code.scss
+- assets/css/primer-markdown/headings.scss
+- assets/css/primer-markdown/images.scss
+- assets/css/primer-markdown/index.scss
+- assets/css/primer-markdown/lists.scss
+- assets/css/primer-markdown/tables.scss
+- assets/css/rouge.scss
 - assets/imgs/back.svg
 - assets/js/anchor.min.js
 - assets/js/index.js
@@ -163,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A Jekyll theme for Github styled documentation