github-docs 0.0.7 → 0.0.19
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 +4 -4
- data/_layouts/default.html +2 -1
- data/{assets/css → _sass}/cherry/_base-normalize.scss +0 -0
- data/{assets/css → _sass}/cherry/_buttons.scss +0 -0
- data/{assets/css → _sass}/cherry/_columns.scss +0 -0
- data/{assets/css → _sass}/cherry/_elements.scss +0 -0
- data/{assets/css → _sass}/cherry/_forms-vue-select.scss +0 -0
- data/{assets/css → _sass}/cherry/_forms.scss +0 -0
- data/{assets/css → _sass}/cherry/_functions.scss +0 -0
- data/{assets/css → _sass}/cherry/_index.scss +0 -0
- data/{assets/css → _sass}/cherry/_layout.scss +0 -0
- data/{assets/css → _sass}/cherry/_modal.scss +0 -0
- data/{assets/css → _sass}/cherry/_spacing.scss +0 -0
- data/{assets/css → _sass}/cherry/_tooltips.scss +0 -0
- data/{assets/css → _sass}/cherry/_typography.scss +0 -0
- data/{assets/css → _sass}/cherry/_utilities.scss +0 -0
- data/{assets/css → _sass}/cherry/_variables-computed.scss +0 -0
- data/{assets/css → _sass}/cherry/_variables.scss +0 -0
- data/{assets/css → _sass}/main.scss +0 -0
- data/{assets/css → _sass}/primer-markdown/blob-csv.scss +0 -0
- data/{assets/css → _sass}/primer-markdown/code.scss +0 -0
- data/{assets/css → _sass}/primer-markdown/headings.scss +0 -0
- data/{assets/css → _sass}/primer-markdown/images.scss +0 -0
- data/{assets/css → _sass}/primer-markdown/index.scss +2 -1
- data/{assets/css → _sass}/primer-markdown/lists.scss +0 -0
- data/{assets/css → _sass}/primer-markdown/tables.scss +0 -0
- data/{assets/css → _sass}/rouge.scss +0 -0
- data/readme.md +14 -6
- metadata +49 -49
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 54c1f265d45aeb2b87e08e2b1adbdf1a12519f59939209b11813c29ea31be3b9
|
|
4
|
+
data.tar.gz: 149c0424f52124c49a77e934c8cc442e6f5ecf553ff951cfe033388ed09bb354
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 94c3e588b6504ed095174025d5c53edd714f67b4ca7b0247c18f48773540f4af9f25a4ceccdd89f270fec06c82ebd8380f605695603d2f9b9e9f762de4c9dec3
|
|
7
|
+
data.tar.gz: 7feb487ebfa30a95a1c21d864851692ce70d8778c247ce845ece4c8b208b1aa5824a35ea49ea39812edb01b7e3607eaaab0bf4210d960aeca63e2e781f176885
|
data/_layouts/default.html
CHANGED
|
@@ -22,7 +22,8 @@
|
|
|
22
22
|
<div class="main-body markdown-body">
|
|
23
23
|
<!-- Edit button -->
|
|
24
24
|
{% if site.github_url != nil and site.github_url != "" %}
|
|
25
|
-
<a href="{{ site.github_url }}/edit/master/{{ page.path }}"
|
|
25
|
+
<a href="{{ site.github_url }}/edit/master/{% if site.basedir %}{{ site.basedir }}/{% endif %}{{ page.path }}"
|
|
26
|
+
class="main-edit-pencil">
|
|
26
27
|
<svg aria-hidden="true" viewBox="0 0 16 16" version="1.1" height="16" width="16">
|
|
27
28
|
<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>
|
|
28
29
|
</svg>
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
|
|
1
2
|
$markdown-line-height: 1.5em;
|
|
2
3
|
$markdown-spacer-1: 4px;
|
|
3
4
|
$markdown-spacer-2: 8px;
|
|
@@ -100,7 +101,7 @@ $gray-700: #444d56;
|
|
|
100
101
|
line-height: 1em;
|
|
101
102
|
font-size: 1.1em !important;
|
|
102
103
|
padding-right: 10px !important;
|
|
103
|
-
//margin-left: calc(-1em - 10px) !important
|
|
104
|
+
//margin-left: calc(-1em - 10px) !important;/////////////////////////////////////
|
|
104
105
|
&:hover,
|
|
105
106
|
&:focus {
|
|
106
107
|
outline: none;
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
data/readme.md
CHANGED
|
@@ -9,16 +9,24 @@ A Jekyll theme for Github styled documentation
|
|
|
9
9
|
remote_theme: boycce/github-docs
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
### Theme preview
|
|
12
|
+
### Theme local preview
|
|
13
13
|
|
|
14
14
|
1. To preview this theme in your project via `github-pages`, add a 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
|
|
20
|
+
|
|
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
|
|
18
26
|
```
|
|
19
27
|
2. Then update `github-pages` and the `theme`
|
|
20
28
|
```
|
|
21
|
-
$ bundle update
|
|
29
|
+
$ bundle install // bundle update to refresh gems
|
|
22
30
|
```
|
|
23
31
|
3. And run
|
|
24
32
|
```
|
|
@@ -28,9 +36,9 @@ A Jekyll theme for Github styled documentation
|
|
|
28
36
|
### Development
|
|
29
37
|
|
|
30
38
|
1. Install rvm/ruby `^2.7.3` if not having done so already
|
|
31
|
-
2.a
|
|
32
|
-
|
|
33
|
-
4. `$ jekyll serve`
|
|
39
|
+
2. (a) `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)
|
|
40
|
+
3. (b) `$ bundle install` (install theme deps automatically)
|
|
41
|
+
4. `$ jekyll serve --port 4001`
|
|
34
42
|
|
|
35
43
|
### Publishing Gem
|
|
36
44
|
|
metadata
CHANGED
|
@@ -1,85 +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
|
+
version: 0.0.19
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ricky Boyce
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2022-02-26 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: '0'
|
|
20
|
-
type: :runtime
|
|
21
|
-
prerelease: false
|
|
22
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
-
requirements:
|
|
24
|
-
- - ">="
|
|
25
|
-
- !ruby/object:Gem::Version
|
|
26
|
-
version: '0'
|
|
27
13
|
- !ruby/object:Gem::Dependency
|
|
28
14
|
name: jekyll
|
|
29
15
|
requirement: !ruby/object:Gem::Requirement
|
|
30
16
|
requirements:
|
|
31
|
-
- -
|
|
17
|
+
- - '='
|
|
32
18
|
- !ruby/object:Gem::Version
|
|
33
19
|
version: 3.9.0
|
|
34
20
|
type: :runtime
|
|
35
21
|
prerelease: false
|
|
36
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
37
23
|
requirements:
|
|
38
|
-
- -
|
|
24
|
+
- - '='
|
|
39
25
|
- !ruby/object:Gem::Version
|
|
40
26
|
version: 3.9.0
|
|
41
27
|
- !ruby/object:Gem::Dependency
|
|
42
28
|
name: jekyll-github-metadata
|
|
43
29
|
requirement: !ruby/object:Gem::Requirement
|
|
44
30
|
requirements:
|
|
45
|
-
- -
|
|
31
|
+
- - '='
|
|
46
32
|
- !ruby/object:Gem::Version
|
|
47
33
|
version: 2.13.0
|
|
48
34
|
type: :runtime
|
|
49
35
|
prerelease: false
|
|
50
36
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
37
|
requirements:
|
|
52
|
-
- -
|
|
38
|
+
- - '='
|
|
53
39
|
- !ruby/object:Gem::Version
|
|
54
40
|
version: 2.13.0
|
|
55
41
|
- !ruby/object:Gem::Dependency
|
|
56
42
|
name: jekyll-seo-tag
|
|
57
43
|
requirement: !ruby/object:Gem::Requirement
|
|
58
44
|
requirements:
|
|
59
|
-
- -
|
|
45
|
+
- - '='
|
|
60
46
|
- !ruby/object:Gem::Version
|
|
61
47
|
version: 2.7.1
|
|
62
48
|
type: :runtime
|
|
63
49
|
prerelease: false
|
|
64
50
|
version_requirements: !ruby/object:Gem::Requirement
|
|
65
51
|
requirements:
|
|
66
|
-
- -
|
|
52
|
+
- - '='
|
|
67
53
|
- !ruby/object:Gem::Version
|
|
68
54
|
version: 2.7.1
|
|
69
55
|
- !ruby/object:Gem::Dependency
|
|
70
56
|
name: kramdown-parser-gfm
|
|
71
57
|
requirement: !ruby/object:Gem::Requirement
|
|
72
58
|
requirements:
|
|
73
|
-
- -
|
|
59
|
+
- - '='
|
|
74
60
|
- !ruby/object:Gem::Version
|
|
75
61
|
version: 1.1.0
|
|
76
62
|
type: :runtime
|
|
77
63
|
prerelease: false
|
|
78
64
|
version_requirements: !ruby/object:Gem::Requirement
|
|
79
65
|
requirements:
|
|
80
|
-
- -
|
|
66
|
+
- - '='
|
|
81
67
|
- !ruby/object:Gem::Version
|
|
82
68
|
version: 1.1.0
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: bundler
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - "~>"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: '2.0'
|
|
76
|
+
type: :development
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - "~>"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: '2.0'
|
|
83
83
|
description:
|
|
84
84
|
email:
|
|
85
85
|
- example@email.com
|
|
@@ -92,32 +92,32 @@ files:
|
|
|
92
92
|
- _layouts/home.html
|
|
93
93
|
- _layouts/page.html
|
|
94
94
|
- _layouts/post.html
|
|
95
|
-
-
|
|
96
|
-
-
|
|
97
|
-
-
|
|
98
|
-
-
|
|
99
|
-
-
|
|
100
|
-
-
|
|
101
|
-
-
|
|
102
|
-
-
|
|
103
|
-
-
|
|
104
|
-
-
|
|
105
|
-
-
|
|
106
|
-
-
|
|
107
|
-
-
|
|
108
|
-
-
|
|
109
|
-
-
|
|
110
|
-
-
|
|
95
|
+
- _sass/cherry/_base-normalize.scss
|
|
96
|
+
- _sass/cherry/_buttons.scss
|
|
97
|
+
- _sass/cherry/_columns.scss
|
|
98
|
+
- _sass/cherry/_elements.scss
|
|
99
|
+
- _sass/cherry/_forms-vue-select.scss
|
|
100
|
+
- _sass/cherry/_forms.scss
|
|
101
|
+
- _sass/cherry/_functions.scss
|
|
102
|
+
- _sass/cherry/_index.scss
|
|
103
|
+
- _sass/cherry/_layout.scss
|
|
104
|
+
- _sass/cherry/_modal.scss
|
|
105
|
+
- _sass/cherry/_spacing.scss
|
|
106
|
+
- _sass/cherry/_tooltips.scss
|
|
107
|
+
- _sass/cherry/_typography.scss
|
|
108
|
+
- _sass/cherry/_utilities.scss
|
|
109
|
+
- _sass/cherry/_variables-computed.scss
|
|
110
|
+
- _sass/cherry/_variables.scss
|
|
111
|
+
- _sass/main.scss
|
|
112
|
+
- _sass/primer-markdown/blob-csv.scss
|
|
113
|
+
- _sass/primer-markdown/code.scss
|
|
114
|
+
- _sass/primer-markdown/headings.scss
|
|
115
|
+
- _sass/primer-markdown/images.scss
|
|
116
|
+
- _sass/primer-markdown/index.scss
|
|
117
|
+
- _sass/primer-markdown/lists.scss
|
|
118
|
+
- _sass/primer-markdown/tables.scss
|
|
119
|
+
- _sass/rouge.scss
|
|
111
120
|
- assets/css/index.scss
|
|
112
|
-
- assets/css/main.scss
|
|
113
|
-
- assets/css/primer-markdown/blob-csv.scss
|
|
114
|
-
- assets/css/primer-markdown/code.scss
|
|
115
|
-
- assets/css/primer-markdown/headings.scss
|
|
116
|
-
- assets/css/primer-markdown/images.scss
|
|
117
|
-
- assets/css/primer-markdown/index.scss
|
|
118
|
-
- assets/css/primer-markdown/lists.scss
|
|
119
|
-
- assets/css/primer-markdown/tables.scss
|
|
120
|
-
- assets/css/rouge.scss
|
|
121
121
|
- assets/imgs/back.svg
|
|
122
122
|
- assets/js/anchor.min.js
|
|
123
123
|
- assets/js/index.js
|