jekyll-rtd-theme 1.0.4 → 1.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cd0100e421bd3ccbc2da040ef98ccdbc657f8aad2224c6544f2baeded4761d5d
4
- data.tar.gz: 6162401684e143cd3690c51dd1e8dcf4430dfe60c3fa670bd9b0928bbd134160
3
+ metadata.gz: 9e0d0a1744c43d43056bd120dc6e607de9d244daff4ba47c13859ded600bbd71
4
+ data.tar.gz: 9fd29cc43e9243a76a6d6faa10f4312d4abf9d84551c1cf6b5c17121b06dfcf3
5
5
  SHA512:
6
- metadata.gz: 30acf708a39d44c221d0a01a74791df3ed94bf5384122ac472574ebd9196fcd25bfe1031c6ec32508e746f5c9444da6fdc2f0e02d896f94b521f627621bbf77a
7
- data.tar.gz: 946c8bf42fb42359567acb26ab3c6ee2cd029d5a7ea5d412524d087081f83223b62bc24a1ba936bfbd4853c2e2cad09de7da1fc6cadceddd4bc49138bad6ae82
6
+ metadata.gz: 1f6e05a1edd9c5ab8883da9e5370d2c5da33c7999060f54b4e1802a666692ba5d325de5ee25021884dc880947fc64496bcfb9698a182581d1de965fbd1d1ac23
7
+ data.tar.gz: 36c4d109990688a69a95ea52606a75984f04055ded488db6609c6f2731d168c6ff683d47bee4ef7186059f137cb6e6db82bdbdc58a02016f6b3b7e37f907cb96
data/README.md CHANGED
@@ -8,36 +8,28 @@
8
8
 
9
9
  Just another documentation theme compatible with GitHub Pages, based on sphinx_rtd_theme
10
10
 
11
- ![][demo]
11
+ ![](https://user-images.githubusercontent.com/68011645/89026666-ad3a8680-d35b-11ea-9f4b-d3fe26ae12ed.png)
12
12
 
13
- ## Notable features
14
- - Write documents directly, automatically generate toctree based on directory
13
+ ## Features
14
+ - Automatically generate sidebar based on directory
15
15
  - Only need one file `_config.yml` to configure site
16
- - Bundled as a "theme gem" for easier installation/upgrading.
17
- - Compatible with GitHub Pages.
18
- - Optimized for search engines with support for Open Graph data.
19
- - Optimized for search engines with `robots.txt` and `sitemap.xml`.
20
- - Search engine (RegExp supported)
21
- - Commenting support
22
- - Google,Baidu,CNZZ Analytics support.
16
+ - Search engine optimized
23
17
  - Multi-language supported
24
- - And many features waiting for you to discover.
18
+ - Document search (RegExp supported)
19
+ - Support third-party comments
20
+ - Google, Baidu, CNZZ Analytics support
25
21
 
26
22
  ## Roadmap
27
- See the [open issues][issues] for a list of proposed features (and known issues).
23
+ See the [open issues](https://github.com/rundocs/jekyll-rtd-theme/issues) for a list of proposed features (and known issues)
28
24
 
29
25
  ## Documents
30
- For full documentation, see: [https://jekyll-rtd-theme.rundocs.io][site]
26
+ You can view theme related [tests](https://jekyll-rtd-theme.rundocs.io), For full documentation, please refer to [https://rundocs.io](https://rundocs.io)
31
27
 
32
28
  ## The License
33
- The theme is available as open source under the terms of the [MIT License][license].
29
+ The theme is available as open source under the terms of the [MIT License](https://github.com/rundocs/jekyll-rtd-theme/blob/master/LICENSE).
34
30
 
35
31
 
36
32
  [repository]: https://github.com/rundocs/jekyll-rtd-theme
37
- [issues]: https://github.com/rundocs/jekyll-rtd-theme/issues
38
- [license]: https://github.com/rundocs/jekyll-rtd-theme/blob/master/LICENSE
39
- [site]: https://jekyll-rtd-theme.rundocs.io
40
33
  [rubygem]: https://rubygems.org/gems/jekyll-rtd-theme
41
34
  [cdn]: https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme/
42
35
  [codefactor]: https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme
43
- [demo]: https://user-images.githubusercontent.com/68011645/88376699-87980500-cdd0-11ea-8900-7bab8c811bc9.png
@@ -31,7 +31,7 @@
31
31
  </p>
32
32
  </div>
33
33
  {%- endif -%}
34
- <div role="contentinfo" class="copyright-rtd">
35
- Powered by <a href="https://rundocs.io">rundocs.io</a>
34
+ <div role="contentinfo" class="copyright rundocs">
35
+ <p>Powered by <a href="https://rundocs.io">rundocs.io</a> using the jekyll docs theme <a href="https://jekyll-rtd-theme.rundocs.io">jekyll-rtd-theme</a></p>
36
36
  </div>
37
37
  </footer>
@@ -1,5 +1,5 @@
1
1
  {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
2
- {%- assign version = "1.0.4" -%}
2
+ {%- assign version = "1.0.5" -%}
3
3
  {%- assign addons = "github, i18n, plugins, analytics" | split: ", " -%}
4
4
 
5
5
  {%- assign schema_lastmod = site.time | date_to_xmlschema -%}
@@ -77,7 +77,8 @@ layout: plugins/compress
77
77
  "@type": "ImageObject",
78
78
  "url": "https://rundocs.io/logo.png"
79
79
  }
80
- }
80
+ },
81
+ "description": "{{ description }}"
81
82
  }
82
83
  </script>
83
84
  <!-- link -->
@@ -106,15 +107,6 @@ layout: plugins/compress
106
107
  }
107
108
  };
108
109
  </script>
109
- {%- if jekyll.environment == "production" -%}
110
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-174262874-1"></script>
111
- <script>
112
- gtag("set", {
113
- "user_id": location.host
114
- });
115
- gtag("config", "UA-174262874-1");
116
- </script>
117
- {%- endif -%}
118
110
  </head>
119
111
 
120
112
  <body class="wy-body-for-nav">
@@ -215,7 +207,6 @@ layout: plugins/compress
215
207
 
216
208
  {% comment %} Google Analytics {% endcomment %}
217
209
  {%- if site.google.gtag -%}
218
- <!-- -->
219
210
  <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google.gtag }}"></script>
220
211
  <script>
221
212
  gtag("config", "{{ site.google.gtag }}");
@@ -50,7 +50,7 @@ footer {
50
50
  font-size: 12px;
51
51
  }
52
52
  /* theme copyright */
53
- .copyright-rtd {
53
+ .rundocs {
54
54
  display: none;
55
55
  }
56
56
  /* view box of search results */
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: 1.0.4
4
+ version: 1.0.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - saowang
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-08-09 00:00:00.000000000 Z
11
+ date: 2020-08-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: github-pages