jekyll-docs-theme 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -17
  3. data/_includes/footer.html +5 -1
  4. data/_includes/google-analytics.html +1 -1
  5. data/_includes/head.html +1 -1
  6. metadata +6 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f31103631540100420139cd432f519a79be7f09c
4
- data.tar.gz: e750c64aa974736a048085417fae63798f68c613
3
+ metadata.gz: 2c444e816077f3fc00a7014288bd896d2109f63f
4
+ data.tar.gz: 3a26f77846f24d672c4c3ef255123c2f06845769
5
5
  SHA512:
6
- metadata.gz: 9e2a866f488db87005863a19bb9c3bd73990552fdf8b60430fbe68c958d0eb6295db4887eeaa9921078af3d46ca41c7b742a930f8b1ff2ab7e88aaf53ccc0dec
7
- data.tar.gz: 43209328f6e26989ea13928d37d0e0d4174fd50fc65540cfdeac7f892804e6ac4c6a8bffb917f5dc9ed29aeb01ac51a8c3e4543eb002e11a25dfe3bf33c39948
6
+ metadata.gz: b2a7b6c385f202668fd3ade13f15bf9e0f87484c74c80a5b34b6e31e01c47e400411697faba2df082adcdb8d112bc5270cb708ef9dae499797fe11cd5cc40bd7
7
+ data.tar.gz: a6989fb0c639a786d36d784c5e9deba911346598b8fee0790082db876349ba714bdace98d92c63dfbb159c10a4b5b3101d8bfe4d982c2003b97852c04bb3b2b9
data/README.md CHANGED
@@ -1,21 +1,25 @@
1
- # jekyll-bootstrap-doc
1
+ # Jekyll Docs Theme
2
2
 
3
- Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes` and your sass in `_sass`. To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
3
+ > This is a [Jekyll theme](https://github.com/allejo/jekyll-docs-theme) based on [mistic100's modification](https://github.com/mistic100/jekyll-docs-theme) of the official Bootstrap documentation from a few years back.
4
4
 
5
- TODO: Delete this and the text above, and describe your gem
5
+ Jekyll Docs Theme is provided as a theme for writing documentation for your projects instead of having a single large README file or several markdown files stored in a not so user-friendly manner.
6
+
7
+ This theme is still in development but is kept fairly stable; just note, there are a lot things yet to come.
8
+
9
+ ![Theme Screenshot](https://raw.githubusercontent.com/allejo/jekyll-docs-theme/master/screenshot.png)
6
10
 
7
11
  ## Installation
8
12
 
9
13
  Add this line to your Jekyll site's Gemfile:
10
14
 
11
15
  ```ruby
12
- gem "jekyll-bootstrap-doc"
16
+ gem "jekyll-docs-theme"
13
17
  ```
14
18
 
15
19
  And add this line to your Jekyll site's `_config.yml`:
16
20
 
17
21
  ```yaml
18
- theme: jekyll-bootstrap-doc
22
+ theme: jekyll-docs-theme
19
23
  ```
20
24
 
21
25
  And then execute:
@@ -24,23 +28,13 @@ And then execute:
24
28
 
25
29
  Or install it yourself as:
26
30
 
27
- $ gem install jekyll-bootstrap-doc
28
-
29
- ## Usage
30
-
31
- TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
32
-
33
- ## Contributing
34
-
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
31
+ $ gem install jekyll-docs-theme
36
32
 
37
33
  ## Development
38
34
 
39
35
  To set up your environment to develop this theme, run `bundle install`.
40
36
 
41
- You theme is setup just like a normal Jelyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
42
-
43
- When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
37
+ To develop on this theme, run `rake preview` and open your browser at `http://localhost:4000`. The project website for this project uses this theme itself and is available in the `docs/` folder.
44
38
 
45
39
  ## License
46
40
 
data/_includes/footer.html CHANGED
@@ -82,4 +82,8 @@
82
82
  <script>
83
83
  trianglify("{{ site.ui.header.color1 }}", "{{ site.ui.header.color2 }}");
84
84
  </script>
85
- {% endif %}
85
+ {% endif %}
86
+
87
+ {% if site.analytics.google %}
88
+ {% include google-analytics.html %}
89
+ {% endif %}
data/_includes/google-analytics.html CHANGED
@@ -3,6 +3,6 @@
3
3
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
4
4
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
5
5
  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
6
- ga('create', '{{ site.google_analytics }}', 'auto');
6
+ ga('create', '{{ site.analytics.google }}', 'auto');
7
7
  ga('send', 'pageview');
8
8
  </script>
data/_includes/head.html CHANGED
@@ -2,7 +2,7 @@
2
2
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
3
3
  <meta name="viewport" content="width=device-width, initial-scale=1">
4
4
 
5
- <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
5
+ <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.name | escape }} {{ site.project.version | escape }}{% endif %}</title>
6
6
  <meta name="description"
7
7
  content="{{ page.excerpt | default: site.description | strip_html | normalize_whitespace | truncate: 160 | escape }}">
8
8
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-docs-theme
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vladimir 'allejo' Jimenez
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-11-02 00:00:00.000000000 Z
11
+ date: 2016-12-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -17,7 +17,7 @@ dependencies:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
19
  version: '3.3'
20
- type: :development
20
+ type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
@@ -78,7 +78,8 @@ files:
78
78
  homepage: https://github.com/allejo/jekyll-docs-theme
79
79
  licenses:
80
80
  - MIT
81
- metadata: {}
81
+ metadata:
82
+ plugin_type: theme
82
83
  post_install_message:
83
84
  rdoc_options: []
84
85
  require_paths:
@@ -95,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
95
96
  version: '0'
96
97
  requirements: []
97
98
  rubyforge_project:
98
- rubygems_version: 2.6.7
99
+ rubygems_version: 2.5.2
99
100
  signing_key:
100
101
  specification_version: 4
101
102
  summary: A Jekyll Gem-based Theme for hosting documentation style websites