github-docs 0.0.22 → 0.1.1

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.
Files changed (16) hide show
  1. checksums.yaml +4 -4
  2. data/_layouts/default.html +7 -0
  3. data/_sass/main.scss +1 -1
  4. data/_sass/{primer-markdown → primer-markdown-custom}/index.scss +1 -1
  5. data/_sass/{primer-markdown → primer-markdown-custom}/lists.scss +1 -1
  6. data/assets/css/index.scss +2 -1
  7. data/assets/imgs/favicon.ico +0 -0
  8. data/assets/imgs/logo.png +0 -0
  9. data/assets/imgs/logo.svg +3 -0
  10. data/readme.md +17 -12
  11. metadata +26 -43
  12. /data/_sass/{primer-markdown → primer-markdown-custom}/blob-csv.scss +0 -0
  13. /data/_sass/{primer-markdown → primer-markdown-custom}/code.scss +0 -0
  14. /data/_sass/{primer-markdown → primer-markdown-custom}/headings.scss +0 -0
  15. /data/_sass/{primer-markdown → primer-markdown-custom}/images.scss +0 -0
  16. /data/_sass/{primer-markdown → primer-markdown-custom}/tables.scss +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 26089badf63939b37bec0af9bd50ad37bf71d65733a7238759c380bd89582784
4
- data.tar.gz: ce5434b6f72e2f2a83b0f451ef1e4c305c832c8b8387af6146789ba9ae0bbff5
3
+ metadata.gz: 941e7215035304e478e92edbd937dd391eca0a64f58dac4ba18c61a09f78ac7d
4
+ data.tar.gz: 0344e721fa62f4d5ff7d8fa01949eb324496739df50e3f54e1660866d26b72b8
5
5
  SHA512:
6
- metadata.gz: d7f5314a6226f33cd8df4e2dc62c6a093874f4fd2a9076be4f94e3386317517024693256b00b3a7541c14236775a9662d92a5c84cbc528bedf746721aa77e264
7
- data.tar.gz: 1c83151952c98e6dedee495289e7a1639891161bd9b4b97d3860fcaf29c603219db5208e5ad3583afcb21cd2ead626e88097067244da4c33fb6749fc6ea29903
6
+ metadata.gz: 4724be14178fa08fedacb98acba82a4892d3424336b01e9d504f161208c228307c45fbbc9b1a496aa7a6eeb3fd5d4b9d823fc4d3979bafb0569a2c5ad13c28fa
7
+ data.tar.gz: d9fe14e9856ebd3f72dd4071d9d989976bcbcb71e0b78832bb5daf7bf250567484d5bc15c30fb7fa5e5e1cd81160785ba82e15c9a16e384a123bf8e5f904a440
data/_layouts/default.html CHANGED
@@ -8,6 +8,13 @@
8
8
  <meta name="viewport" content="width=device-width, initial-scale=1">
9
9
  <link rel="stylesheet" href="{{ "/assets/css/index.css?v=1" | relative_url }}">
10
10
  <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;900&display=swap" rel="stylesheet">
11
+ {% if site.favicon %}
12
+ <link rel="icon" href="{{ site.favicon | relative_url }}" type="image/x-icon">
13
+ <!-- <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
14
+ <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
15
+ <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
16
+ <link rel="manifest" href="/site.webmanifest"> -->
17
+ {% endif %}
11
18
  {% seo %}
12
19
  </head>
13
20
  <body>
data/_sass/main.scss CHANGED
@@ -15,7 +15,7 @@ $menu-color: #483973;
15
15
  }
16
16
  .main-body {
17
17
  display: block;
18
- max-width: 910px;
18
+ max-width: 950px;
19
19
  margin: 0 auto;
20
20
  padding: 40px;
21
21
  padding-top: 50px;
data/_sass/{primer-markdown → primer-markdown-custom}/index.scss RENAMED
@@ -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;
data/_sass/{primer-markdown → primer-markdown-custom}/lists.scss RENAMED
@@ -21,7 +21,7 @@
21
21
  margin-top: $markdown-spacer-3;
22
22
  }
23
23
  li + li {
24
- margin-top: 0.25em;
24
+ margin-top: 0.55em;
25
25
  }
26
26
  dl {
27
27
  padding: 0;
data/assets/css/index.scss CHANGED
@@ -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/assets/imgs/favicon.ico ADDED
Binary file
data/assets/imgs/logo.png ADDED
Binary file
data/assets/imgs/logo.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg width="17" height="16" viewBox="0 0 17 16" fill="none" xmlns="http://www.w3.org/2000/svg">
2
+ <path fill-rule="evenodd" clip-rule="evenodd" d="M2.58162 3.55075V12.3046C2.4831 13.7043 3.87058 14.9903 5.24122 14.9903H13.9193C14.2698 14.9903 14.5088 14.7154 14.5088 14.336V13.7632C14.5088 13.5929 14.0982 13.438 14.0982 13.3142C14.0982 13.2538 14.0285 12.8463 14.0285 12.4162C14.0285 11.9641 14.0982 11.4885 14.0982 11.433C14.0982 11.3246 14.5088 11.0846 14.5088 10.8988V1.96209C14.5088 1.46918 14.325 1.00977 13.6673 1.00977H5.03738C3.67567 1.00977 2.58162 2.25389 2.58162 3.55075ZM11.4938 4.08795H5.73558C5.62814 4.08795 5.54105 4.17505 5.54105 4.28248V4.73573C5.54105 4.84317 5.62814 4.93027 5.73558 4.93027H11.4938C11.6013 4.93027 11.6884 4.84317 11.6884 4.73573V4.28248C11.6884 4.17505 11.6013 4.08795 11.4938 4.08795ZM11.4938 6.05101H5.73558C5.62814 6.05101 5.54105 6.1381 5.54105 6.24554V6.69879C5.54105 6.80623 5.62814 6.89332 5.73558 6.89332H11.4938C11.6013 6.89332 11.6884 6.80623 11.6884 6.69879V6.24554C11.6884 6.1381 11.6013 6.05101 11.4938 6.05101ZM12.8252 11.0315C12.8252 11.0315 12.6781 11.4331 12.6781 11.8953C12.6781 12.3576 12.8252 12.9355 12.8252 12.9355H5.03739C3.92484 12.9355 3.75628 11.0315 5.03739 11.0315H12.8252Z" fill="black"/>
3
+ </svg>
data/readme.md CHANGED
@@ -9,26 +9,31 @@ A Jekyll theme for Github styled documentation
9
9
  remote_theme: boycce/github-docs
10
10
  ```
11
11
 
12
- ### Theme local preview
12
+ ### Theme usage (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,15 +1,29 @@
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.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ricky Boyce
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-02-26 00:00:00.000000000 Z
11
+ date: 2025-04-01 00:00:00.000000000 Z
12
12
  dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
13
27
  - !ruby/object:Gem::Dependency
14
28
  name: jekyll
15
29
  requirement: !ruby/object:Gem::Requirement
@@ -66,26 +80,6 @@ dependencies:
66
80
  - - '='
67
81
  - !ruby/object:Gem::Version
68
82
  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
83
  - !ruby/object:Gem::Dependency
90
84
  name: rouge
91
85
  requirement: !ruby/object:Gem::Requirement
@@ -114,20 +108,6 @@ dependencies:
114
108
  - - '='
115
109
  - !ruby/object:Gem::Version
116
110
  version: 1.5.2
117
- - !ruby/object:Gem::Dependency
118
- name: bundler
119
- requirement: !ruby/object:Gem::Requirement
120
- requirements:
121
- - - "~>"
122
- - !ruby/object:Gem::Version
123
- version: '2.0'
124
- type: :development
125
- prerelease: false
126
- version_requirements: !ruby/object:Gem::Requirement
127
- requirements:
128
- - - "~>"
129
- - !ruby/object:Gem::Version
130
- version: '2.0'
131
111
  description:
132
112
  email:
133
113
  - example@email.com
@@ -157,16 +137,19 @@ 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
150
+ - assets/imgs/favicon.ico
151
+ - assets/imgs/logo.png
152
+ - assets/imgs/logo.svg
170
153
  - assets/js/anchor.min.js
171
154
  - assets/js/index.js
172
155
  - readme.md