github-docs 0.0.22 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 26089badf63939b37bec0af9bd50ad37bf71d65733a7238759c380bd89582784
4
- data.tar.gz: ce5434b6f72e2f2a83b0f451ef1e4c305c832c8b8387af6146789ba9ae0bbff5
3
+ metadata.gz: 726b5af62b9ed8958b16ebbea309f35cbee61b7af922e324986e7ba8318002dc
4
+ data.tar.gz: 5c04cba616a55a3897a52250c37152e650fbf49d3d0d6df54b41186192c9b23a
5
5
  SHA512:
6
- metadata.gz: d7f5314a6226f33cd8df4e2dc62c6a093874f4fd2a9076be4f94e3386317517024693256b00b3a7541c14236775a9662d92a5c84cbc528bedf746721aa77e264
7
- data.tar.gz: 1c83151952c98e6dedee495289e7a1639891161bd9b4b97d3860fcaf29c603219db5208e5ad3583afcb21cd2ead626e88097067244da4c33fb6749fc6ea29903
6
+ metadata.gz: f4dc86d6d1cd8adb895cc8ce96720a2ee955f56fed4714a5fa25c1792dd93941911f328249db018d4728b00e34c3b27d9d59dd41a425425aa61a3f2151cd909a
7
+ data.tar.gz: c4197237733300793b96b12ad2a3435180b29643ea439f7def7328cd9a831ee945b0b13169e40bce9bdda4f88c6b6460057dbb938382eda5101ead386904d1ea
@@ -101,7 +101,7 @@ $gray-700: #444d56;
101
101
  line-height: 1em;
102
102
  font-size: 1.1em !important;
103
103
  padding-right: 10px !important;
104
- //margin-left: calc(-1em - 10px) !important;/////////////////////////////////////
104
+ margin-left: calc(-1em - 10px) !important;
105
105
  &:hover,
106
106
  &:focus {
107
107
  outline: none;
@@ -15,4 +15,5 @@ $family-primary: -apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,san
15
15
  "Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
16
16
 
17
17
  // Load modules
18
- @import "primer-markdown", "cherry", "main", "rouge";
18
+ // We're appending '-custom' to 'primer-markdown' to avoid including the original dependency
19
+ @import "primer-markdown-custom", "cherry", "main", "rouge";
data/readme.md CHANGED
@@ -11,24 +11,29 @@ A Jekyll theme for Github styled documentation
11
11
 
12
12
  ### Theme local preview
13
13
 
14
- 1. To preview this theme in your project via `github-pages`, add a Gemfile in your root folder
14
+ 1. To preview this theme for your project, add the following Gemfile in your root folder
15
15
  ```ruby
16
16
  source 'https://rubygems.org'
17
17
 
18
- # (old)
19
- # gem 'github-pages', group: :jekyll_plugins
18
+ # Use one of the following:
20
19
 
21
- # Below pulls the latest remote_theme in development (https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages)
22
- gem "github-docs", git: "https://github.com/boycce/github-docs"
23
- group :jekyll_plugins do
24
- gem "jekyll-remote-theme", "~> 0.4.2"
25
- end
20
+ # 1. simulate github-pages
21
+ gem 'github-pages', group: :jekyll_plugins
22
+
23
+ # 2. Or use jekyll-remote-theme, contains unsupported dependency versions, e.g. Sass issues
24
+ # https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages
25
+ # gem "github-docs", git: "https://github.com/boycce/github-docs"
26
+ # group :jekyll_plugins do
27
+ # gem "jekyll-remote-theme", "~> 0.4.2"
28
+ # end
26
29
  ```
27
- 2. Then update `github-pages` and the `theme`
30
+
31
+ 2. Install or update dependencies
28
32
  ```
29
- $ bundle install // bundle update to refresh gems
33
+ $ bundle install // or bundle update
30
34
  ```
31
- 3. And run
35
+
36
+ 3. And run (github-pages pulls the latest remote_theme)
32
37
  ```
33
38
  $ bundle exec jekyll serve
34
39
  ```
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: github-docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.22
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ricky Boyce
@@ -66,26 +66,6 @@ dependencies:
66
66
  - - '='
67
67
  - !ruby/object:Gem::Version
68
68
  version: 1.1.0
69
- - !ruby/object:Gem::Dependency
70
- name: rake
71
- requirement: !ruby/object:Gem::Requirement
72
- requirements:
73
- - - ">="
74
- - !ruby/object:Gem::Version
75
- version: 12.3.1
76
- - - "<"
77
- - !ruby/object:Gem::Version
78
- version: 13.1.0
79
- type: :runtime
80
- prerelease: false
81
- version_requirements: !ruby/object:Gem::Requirement
82
- requirements:
83
- - - ">="
84
- - !ruby/object:Gem::Version
85
- version: 12.3.1
86
- - - "<"
87
- - !ruby/object:Gem::Version
88
- version: 13.1.0
89
69
  - !ruby/object:Gem::Dependency
90
70
  name: rouge
91
71
  requirement: !ruby/object:Gem::Requirement
@@ -157,13 +137,13 @@ files:
157
137
  - _sass/cherry/_variables-computed.scss
158
138
  - _sass/cherry/_variables.scss
159
139
  - _sass/main.scss
160
- - _sass/primer-markdown/blob-csv.scss
161
- - _sass/primer-markdown/code.scss
162
- - _sass/primer-markdown/headings.scss
163
- - _sass/primer-markdown/images.scss
164
- - _sass/primer-markdown/index.scss
165
- - _sass/primer-markdown/lists.scss
166
- - _sass/primer-markdown/tables.scss
140
+ - _sass/primer-markdown-custom/blob-csv.scss
141
+ - _sass/primer-markdown-custom/code.scss
142
+ - _sass/primer-markdown-custom/headings.scss
143
+ - _sass/primer-markdown-custom/images.scss
144
+ - _sass/primer-markdown-custom/index.scss
145
+ - _sass/primer-markdown-custom/lists.scss
146
+ - _sass/primer-markdown-custom/tables.scss
167
147
  - _sass/rouge.scss
168
148
  - assets/css/index.scss
169
149
  - assets/imgs/back.svg