jekyll-theme-docs 0.0.1 → 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +43 -2
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2b04ab929b27013ae3894add4fb2439615bec956
|
|
4
|
+
data.tar.gz: 69ed4808ad65b32f66c979f0d45cd13c5ac52344
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 44cf910494a9d502acab30d65a436b211a81e1a8654adabc858740ec9b05da148529bba4a73dc4af3f03f8d92bd5549d19a4606d7548613facc0b76d4fc89816
|
|
7
|
+
data.tar.gz: 555b56cf271c074e16e92cbc6bd1ba2a16bf09b3887681955adcf813d274d69acbb3def15cec8dec23b52c29d82d18a461ab58ca6ba29c2182189d89e5297adf
|
data/README.md
CHANGED
|
@@ -1,2 +1,43 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
1
|
+
# Jekyll Theme Docs
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/rb/jekyll-theme-docs)
|
|
4
|
+
|
|
5
|
+
Bootstrap theme to host documentation. SEO optimized, Google CSE, Formspree and Disqus comments.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```ruby
|
|
10
|
+
gem "jekyll-theme-docs"
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
And add this line to your Jekyll site's `_config.yml`:
|
|
14
|
+
|
|
15
|
+
```yaml
|
|
16
|
+
theme: jekyll-theme-docs
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
And then execute:
|
|
20
|
+
|
|
21
|
+
$ bundle
|
|
22
|
+
|
|
23
|
+
Or install it yourself as:
|
|
24
|
+
|
|
25
|
+
$ gem install jekyll-theme-docs
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## Contributing
|
|
29
|
+
|
|
30
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/jekyll-theme-docs/jekyll-theme-docs.github.io. 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
|
+
|
|
32
|
+
## Development
|
|
33
|
+
|
|
34
|
+
To set up your environment to develop this theme, run `bundle install`.
|
|
35
|
+
|
|
36
|
+
Your theme is setup just like a normal Jekyll 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.
|
|
37
|
+
|
|
38
|
+
When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
|
|
39
|
+
|
|
40
|
+
## License
|
|
41
|
+
|
|
42
|
+
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
43
|
+
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-theme-docs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Natan Felles
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2017-
|
|
11
|
+
date: 2017-05-21 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
129
129
|
version: '0'
|
|
130
130
|
requirements: []
|
|
131
131
|
rubyforge_project:
|
|
132
|
-
rubygems_version: 2.5.
|
|
132
|
+
rubygems_version: 2.5.2
|
|
133
133
|
signing_key:
|
|
134
134
|
specification_version: 4
|
|
135
135
|
summary: Bootstrap theme to host documentation. SEO optimized, Google CSE, Formspree
|