jekyll-rtd-theme 0.0.1 → 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +28 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5ec9e0b342599501734319987d2e9e126b1ec68f9fda65b68f3e8db033af4057
|
|
4
|
+
data.tar.gz: f5f5cc84de3b2676732e3cd9df4b85bdd61ec6a44814a6b9d9e1e4abb990c035
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 492da44c0119656b6c917da857df833b41d519a2c3a74505cdf2cb2aa702ccfdb2a015e7b7627aab4362297513033a54fca19c3fe0ee0a108397b97bb21b92a8
|
|
7
|
+
data.tar.gz: 7a42ad86878239b5afe11a02d747c2ab28c484f66064d69266559adc400b2179ae4eaf5e6c95befa7d0b860648e114add25a79d06c2940c937192e0fb29383a2
|
data/README.md
CHANGED
|
@@ -1,10 +1,37 @@
|
|
|
1
1
|
# jekyll-rtd-theme
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
Just another Jekyll theme for GitHub Pages based on ReadtheDocs's sphinx_rtd_theme styles
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
There are two ways to install: as a gem-based theme, as a remote theme (GitHub Pages compatible)
|
|
10
|
+
|
|
11
|
+
#### Gem-based method
|
|
12
|
+
1. Add the following to your github repository's `Gemfile`
|
|
13
|
+
```ruby
|
|
14
|
+
source "https://rubygems.org"
|
|
15
|
+
gem "jekyll-rtd-theme"
|
|
16
|
+
gem "github-pages", group: :jekyll_plugins
|
|
17
|
+
```
|
|
18
|
+
2. Add the following to your github repository's `_config.yml`
|
|
19
|
+
```yml
|
|
20
|
+
theme: jekyll-rtd-theme
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
#### Remote theme method
|
|
24
|
+
1. Add the following to your site's `_config.yml`
|
|
25
|
+
```yml
|
|
26
|
+
remote_theme: rundocs/jekyll-rtd-theme
|
|
27
|
+
```
|
|
28
|
+
2. Remove any other `theme` or `remote_theme` entry
|
|
2
29
|
|
|
3
|
-
Just another Jekyll theme for GitHub Pages
|
|
4
30
|
|
|
5
31
|
## Roadmap
|
|
6
32
|
See the [open issues][issues] for a list of proposed features (and known issues).
|
|
7
33
|
|
|
34
|
+
|
|
8
35
|
## Contributing
|
|
9
36
|
1. Clone down the theme's repository (`git clone https://github.com/rundocs/jekyll-rtd-theme.git`)
|
|
10
37
|
2. `cd` into the theme's directory
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-rtd-theme
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0
|
|
4
|
+
version: 0.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- saowang
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-07-
|
|
11
|
+
date: 2020-07-22 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: github-pages
|