github-docs 0.0.3 → 0.0.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_layouts/default.html +1 -1
- data/readme.md +9 -9
- metadata +1 -15
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6499657a218c8899f4f7faaf1da9e4381c87885d49da21d13fef25b189190bf8
|
|
4
|
+
data.tar.gz: e4a06cf64083d792c12cccbdbbfb7179232c1cd562311bf95df1f28c28c3ff84
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 21106a6d1f81af6793edc05870a9122c929bb6a8e7ab6999b8f2a229eabe848e37912787e2d584164a98d7e0de8f940e0d37273aa34ed175d2460c87b37cec4f
|
|
7
|
+
data.tar.gz: bcb4a87ed7105678bd76140909bd51d2142d4b2a3499b4d84d2048892149dc005e29fd8037cd760d31381b6b5b099b4285668c3db6c2f208e46cd08bfd7031e9
|
data/_layouts/default.html
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
</div>
|
|
18
18
|
<div class="content">
|
|
19
19
|
<div class="content-body p-6 markdown-body">
|
|
20
|
-
{{ content }}
|
|
20
|
+
{{ content | replace: '<a href="http', '<a rel="nofollow noopener noreferrer" target="_blank" href="http' }}
|
|
21
21
|
{% if page.has_children == true and page.has_toc != false %}
|
|
22
22
|
<hr>
|
|
23
23
|
<h2 class="text-delta">Table of contents</h2>
|
data/readme.md
CHANGED
|
@@ -6,31 +6,31 @@ A Jekyll theme for Github styled documentation
|
|
|
6
6
|
|
|
7
7
|
Add a _config.yml file with this line:
|
|
8
8
|
```yaml
|
|
9
|
-
|
|
9
|
+
remote_theme: boycce/github-docs
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
### Preview
|
|
12
|
+
### Preview theme locally via github-pages
|
|
13
13
|
|
|
14
|
-
Add
|
|
14
|
+
Add a Gemfile in your documention root
|
|
15
15
|
```ruby
|
|
16
|
-
|
|
16
|
+
source 'https://rubygems.org'
|
|
17
|
+
gem 'github-pages', group: :jekyll_plugins
|
|
17
18
|
```
|
|
18
19
|
|
|
19
|
-
|
|
20
|
+
then update `github-pages` and the `theme`
|
|
20
21
|
```
|
|
21
|
-
$ bundle
|
|
22
|
+
$ bundle update
|
|
22
23
|
```
|
|
23
24
|
|
|
24
|
-
|
|
25
|
+
run via
|
|
25
26
|
```
|
|
26
|
-
$
|
|
27
|
+
$ bundle exec jekyll serve
|
|
27
28
|
```
|
|
28
29
|
|
|
29
30
|
### Development
|
|
30
31
|
|
|
31
32
|
1. `$ gem install bundler`
|
|
32
33
|
2. `$ bundle install` (install theme deps)
|
|
33
|
-
3. `$ bundle exec` (build files)
|
|
34
34
|
3. `$ jekyll serve`
|
|
35
35
|
|
|
36
36
|
### Publishing Gem
|
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.
|
|
4
|
+
version: 0.0.4
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ricky Boyce
|
|
@@ -72,20 +72,6 @@ dependencies:
|
|
|
72
72
|
- - "~>"
|
|
73
73
|
- !ruby/object:Gem::Version
|
|
74
74
|
version: '2.0'
|
|
75
|
-
- !ruby/object:Gem::Dependency
|
|
76
|
-
name: jekyll-target-blank
|
|
77
|
-
requirement: !ruby/object:Gem::Requirement
|
|
78
|
-
requirements:
|
|
79
|
-
- - "~>"
|
|
80
|
-
- !ruby/object:Gem::Version
|
|
81
|
-
version: '2.0'
|
|
82
|
-
type: :runtime
|
|
83
|
-
prerelease: false
|
|
84
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
85
|
-
requirements:
|
|
86
|
-
- - "~>"
|
|
87
|
-
- !ruby/object:Gem::Version
|
|
88
|
-
version: '2.0'
|
|
89
75
|
description:
|
|
90
76
|
email:
|
|
91
77
|
- example@email.com
|