github-docs 0.0.4 → 0.0.5

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 (6) hide show
  1. checksums.yaml +4 -4
  2. data/_layouts/default.html +7 -0
  3. data/_sass/github-docs.scss +28 -2
  4. data/_sass/primer-markdown/markdown-body.scss +0 -0
  5. data/readme.md +24 -25
  6. metadata +29 -21
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6499657a218c8899f4f7faaf1da9e4381c87885d49da21d13fef25b189190bf8
4
- data.tar.gz: e4a06cf64083d792c12cccbdbbfb7179232c1cd562311bf95df1f28c28c3ff84
3
+ metadata.gz: d92adafc953150774d3c3e33b62d492410751cdec163fe19c6ed9abd3a43c396
4
+ data.tar.gz: 349ecdd604e3ea311408e804df895f0e182135804aa3fc85e0b2c99a655ebddd
5
5
  SHA512:
6
- metadata.gz: 21106a6d1f81af6793edc05870a9122c929bb6a8e7ab6999b8f2a229eabe848e37912787e2d584164a98d7e0de8f940e0d37273aa34ed175d2460c87b37cec4f
7
- data.tar.gz: bcb4a87ed7105678bd76140909bd51d2142d4b2a3499b4d84d2048892149dc005e29fd8037cd760d31381b6b5b099b4285668c3db6c2f208e46cd08bfd7031e9
6
+ metadata.gz: 6bc6cb8d4c0bd60c1494b3f956f673fc313b5209d08050110d99e3e5e44f28852ed224bffde7b2c071175e05a399a4088d55cba3f522b0c395f8060e4bccd5c0
7
+ data.tar.gz: e6a91eaab077009fbe52aa0ee35c9b28e35e17e64b323b93e981dc5adf3847b51fc6fd84ce60bf5f298572d32ce94d6b52a21c1fb0e0b8e1b89a854687f5049c
data/_layouts/default.html CHANGED
@@ -17,6 +17,13 @@
17
17
  </div>
18
18
  <div class="content">
19
19
  <div class="content-body p-6 markdown-body">
20
+ {% if site.githuburl != nil and site.githuburl != "" %}
21
+ <a href="{{ site.githuburl }}/edit/master/{{ page.path }}" class="content-edit-md">
22
+ <svg aria-hidden="true" viewBox="0 0 16 16" version="1.1" height="16" width="16">
23
+ <path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
24
+ </svg>
25
+ </a>
26
+ {% endif %}
20
27
  {{ content | replace: '<a href="http', '<a rel="nofollow noopener noreferrer" target="_blank" href="http' }}
21
28
  {% if page.has_children == true and page.has_toc != false %}
22
29
  <hr>
data/_sass/github-docs.scss CHANGED
@@ -13,6 +13,32 @@ $menu-color: #483973;
13
13
  display: block;
14
14
  margin-left: $sidebar-width;
15
15
  }
16
+ .content-edit-md {
17
+ float: right;
18
+ display: block;
19
+ margin-top: 24px !important;
20
+ padding: 10px;
21
+ line-height: 0em;
22
+ border-radius: 6px;
23
+ color: #6a737d;
24
+ background: transparent;
25
+ transition: .2s cubic-bezier(.3,0,.5,1);
26
+ transition-property: color,background-color,border-color;
27
+ svg {
28
+ fill: #6a737d;
29
+ }
30
+ &:hover,
31
+ &:active {
32
+ background-color: #F3F4F6;
33
+ border-color: #1b1f2326;
34
+ transition-duration: .1s;
35
+ }
36
+ }
37
+ .markdown-body {
38
+ > .content-edit-md + * {
39
+ margin-top: 0 !important;
40
+ }
41
+ }
16
42
  .content-heading {
17
43
  display: block;
18
44
  }
@@ -107,7 +133,7 @@ $menu-color: #483973;
107
133
  margin-left: -2px;
108
134
  }
109
135
  .sidebar-close:hover {
110
-
136
+
111
137
  }
112
138
  @media (max-width: 800px) {
113
139
  .sidebar {
@@ -140,7 +166,7 @@ $menu-color: #483973;
140
166
  top: 0;
141
167
  left: 0;
142
168
  right: 100%;
143
- bottom: 0;
169
+ bottom: 0;
144
170
  z-index: 0;
145
171
  opacity: 0;
146
172
  background-color: rgba(24, 48, 85, 0.3);
data/_sass/primer-markdown/markdown-body.scss CHANGED
File without changes
data/readme.md CHANGED
@@ -4,34 +4,33 @@ A Jekyll theme for Github styled documentation
4
4
 
5
5
  ### Theme usage
6
6
 
7
- Add a _config.yml file with this line:
8
- ```yaml
9
- remote_theme: boycce/github-docs
10
- ```
11
-
12
- ### Preview theme locally via github-pages
13
-
14
- Add a Gemfile in your documention root
15
- ```ruby
16
- source 'https://rubygems.org'
17
- gem 'github-pages', group: :jekyll_plugins
18
- ```
19
-
20
- then update `github-pages` and the `theme`
21
- ```
22
- $ bundle update
23
- ```
24
-
25
- run via
26
- ```
27
- $ bundle exec jekyll serve
28
- ```
7
+ 1. To use this theme in your project via `github-pages`, add a _config.yml file with this line
8
+ ```yaml
9
+ remote_theme: boycce/github-docs
10
+ ```
11
+
12
+ ### Theme preview
13
+
14
+ 1. To preview this theme in your project via `github-pages`, add a Gemfile in your root folder
15
+ ```ruby
16
+ source 'https://rubygems.org'
17
+ gem 'github-pages', group: :jekyll_plugins
18
+ ```
19
+ 2. Then update `github-pages` and the `theme`
20
+ ```
21
+ $ bundle update
22
+ ```
23
+ 3. And run
24
+ ```
25
+ $ bundle exec jekyll serve
26
+ ```
29
27
 
30
28
  ### Development
31
29
 
32
- 1. `$ gem install bundler`
33
- 2. `$ bundle install` (install theme deps)
34
- 3. `$ jekyll serve`
30
+ 1. Install rvm/ruby `^2.7.3` if not having done so already
31
+ 2. `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)
32
+ 3. `$ bundle install` (install theme deps automatically)
33
+ 4. `$ jekyll serve`
35
34
 
36
35
  ### Publishing Gem
37
36
 
metadata CHANGED
@@ -1,77 +1,85 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: github-docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.4
4
+ version: 0.0.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ricky Boyce
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-05-18 00:00:00.000000000 Z
11
+ date: 2021-07-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 2.1.4
19
+ version: '0'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "~>"
24
+ - - ">="
25
25
  - !ruby/object:Gem::Version
26
- version: 2.1.4
26
+ version: '0'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: jekyll
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - ">="
32
- - !ruby/object:Gem::Version
33
- version: '3.5'
34
- - - "<"
31
+ - - "~>"
35
32
  - !ruby/object:Gem::Version
36
- version: '5.0'
33
+ version: 3.9.0
37
34
  type: :runtime
38
35
  prerelease: false
39
36
  version_requirements: !ruby/object:Gem::Requirement
40
37
  requirements:
41
- - - ">="
42
- - !ruby/object:Gem::Version
43
- version: '3.5'
44
- - - "<"
38
+ - - "~>"
45
39
  - !ruby/object:Gem::Version
46
- version: '5.0'
40
+ version: 3.9.0
47
41
  - !ruby/object:Gem::Dependency
48
42
  name: jekyll-github-metadata
49
43
  requirement: !ruby/object:Gem::Requirement
50
44
  requirements:
51
45
  - - "~>"
52
46
  - !ruby/object:Gem::Version
53
- version: '2.9'
47
+ version: 2.13.0
54
48
  type: :runtime
55
49
  prerelease: false
56
50
  version_requirements: !ruby/object:Gem::Requirement
57
51
  requirements:
58
52
  - - "~>"
59
53
  - !ruby/object:Gem::Version
60
- version: '2.9'
54
+ version: 2.13.0
61
55
  - !ruby/object:Gem::Dependency
62
56
  name: jekyll-seo-tag
63
57
  requirement: !ruby/object:Gem::Requirement
64
58
  requirements:
65
59
  - - "~>"
66
60
  - !ruby/object:Gem::Version
67
- version: '2.0'
61
+ version: 2.7.1
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 2.7.1
69
+ - !ruby/object:Gem::Dependency
70
+ name: kramdown-parser-gfm
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 1.1.0
68
76
  type: :runtime
69
77
  prerelease: false
70
78
  version_requirements: !ruby/object:Gem::Requirement
71
79
  requirements:
72
80
  - - "~>"
73
81
  - !ruby/object:Gem::Version
74
- version: '2.0'
82
+ version: 1.1.0
75
83
  description:
76
84
  email:
77
85
  - example@email.com
@@ -149,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
149
157
  - !ruby/object:Gem::Version
150
158
  version: '0'
151
159
  requirements: []
152
- rubygems_version: 3.0.6
160
+ rubygems_version: 3.1.6
153
161
  signing_key:
154
162
  specification_version: 4
155
163
  summary: A Jekyll theme for Github styled documentation