github-docs 0.0.19 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54c1f265d45aeb2b87e08e2b1adbdf1a12519f59939209b11813c29ea31be3b9
-  data.tar.gz: 149c0424f52124c49a77e934c8cc442e6f5ecf553ff951cfe033388ed09bb354
+  metadata.gz: 726b5af62b9ed8958b16ebbea309f35cbee61b7af922e324986e7ba8318002dc
+  data.tar.gz: 5c04cba616a55a3897a52250c37152e650fbf49d3d0d6df54b41186192c9b23a
 SHA512:
-  metadata.gz: 94c3e588b6504ed095174025d5c53edd714f67b4ca7b0247c18f48773540f4af9f25a4ceccdd89f270fec06c82ebd8380f605695603d2f9b9e9f762de4c9dec3
-  data.tar.gz: 7feb487ebfa30a95a1c21d864851692ce70d8778c247ce845ece4c8b208b1aa5824a35ea49ea39812edb01b7e3607eaaab0bf4210d960aeca63e2e781f176885
+  metadata.gz: f4dc86d6d1cd8adb895cc8ce96720a2ee955f56fed4714a5fa25c1792dd93941911f328249db018d4728b00e34c3b27d9d59dd41a425425aa61a3f2151cd909a
+  data.tar.gz: c4197237733300793b96b12ad2a3435180b29643ea439f7def7328cd9a831ee945b0b13169e40bce9bdda4f88c6b6460057dbb938382eda5101ead386904d1ea

data/_sass/{primer-markdown → primer-markdown-custom}/index.scss

@@ -101,7 +101,7 @@ $gray-700: #444d56;
     line-height: 1em;
     font-size: 1.1em !important;
     padding-right: 10px !important;
-    //margin-left: calc(-1em - 10px) !important;/////////////////////////////////////
+    margin-left: calc(-1em - 10px) !important;
     &:hover,
     &:focus {
       outline: none;

data/assets/css/index.scss

@@ -15,4 +15,5 @@ $family-primary: -apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,san
   "Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
 
 // Load modules
-@import "primer-markdown", "cherry", "main", "rouge";
+// We're appending '-custom' to 'primer-markdown' to avoid including the original dependency
+@import "primer-markdown-custom", "cherry", "main", "rouge";

data/readme.md

@@ -11,24 +11,29 @@ A Jekyll theme for Github styled documentation
 
 ### Theme local preview
 
-1. To preview this theme in your project via `github-pages`, add a Gemfile in your root folder
+1. To preview this theme for your project, add the following Gemfile in your root folder
     ```ruby
     source 'https://rubygems.org'
 
-    # (old)
-    # gem 'github-pages', group: :jekyll_plugins
+    # Use one of the following:
 
-    # Below pulls the latest remote_theme in development (https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages)
-    gem "github-docs", git: "https://github.com/boycce/github-docs"
-    group :jekyll_plugins do
-      gem "jekyll-remote-theme", "~> 0.4.2"
-    end
+    # 1. simulate github-pages
+    gem 'github-pages', group: :jekyll_plugins
+
+    # 2. Or use jekyll-remote-theme, contains unsupported dependency versions, e.g. Sass issues
+    #   https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages
+    # 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`
+
+2. Install or update dependencies
     ```
-    $ bundle install // bundle update to refresh gems
+    $ bundle install // or bundle update
     ```
-3. And run
+
+3. And run (github-pages pulls the latest remote_theme)
     ```
     $ bundle exec jekyll serve
     ```
@@ -44,3 +49,5 @@ A Jekyll theme for Github styled documentation
 
 1. `$ gem build github-docs.gemspec`
 2. `$ gem push github-docs-*.gem`
+or
+1. `$ rm ./*.gem 2>/dev/null && gem build github-docs.gemspec && gem push github-docs-*.gem`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-docs
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.1.0
 platform: ruby
 authors:
 - Ricky Boyce
@@ -66,6 +66,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.26.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.26.0
+- !ruby/object:Gem::Dependency
+  name: jekyll-sass-converter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,13 +137,13 @@ files:
 - _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/tables.scss
+- _sass/primer-markdown-custom/blob-csv.scss
+- _sass/primer-markdown-custom/code.scss
+- _sass/primer-markdown-custom/headings.scss
+- _sass/primer-markdown-custom/images.scss
+- _sass/primer-markdown-custom/index.scss
+- _sass/primer-markdown-custom/lists.scss
+- _sass/primer-markdown-custom/tables.scss
 - _sass/rouge.scss
 - assets/css/index.scss
 - assets/imgs/back.svg