vitrina 0.2.6 → 0.2.8

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: 92ad19de6e43ac4e4504ea39976afa354b0618a62228195bc8a64b1b4304e4e6
4
- data.tar.gz: 135e40d594dd1cf47d781905f5022feb501b4f7b3b254bcaf70c70fcbfa5bad4
3
+ metadata.gz: 7bb20cd40db98a35ed50fe72937bd028c2a6983ce064a333005cc8f60153b216
4
+ data.tar.gz: cd72cebf380e97ffcb1fa9a39c4c611ceb098a5bd10298d958659b81d9d6aaa9
5
5
  SHA512:
6
- metadata.gz: abf872026591b78c4176ee10515a40c5fc65b879184416b145fc62667129413bc88d451c9de927b9ecc3a907a2f0322d020041faaaae252852eaa8f6da38f1c7
7
- data.tar.gz: 6628fefb8b5109535a108685c5d462938a75f481faba5da700cf5a714802f80d29052a2b40571cb42d48d0d05e37cdcd602252ae33a36d95b693a3ee086e5753
6
+ metadata.gz: 350df0bbbc95251e9bee9c9f1b1f544ad454242f71d6e22a838e32dc1d0984a61c43ba646e8ffe8fcbd71c0c1e210f70596e14dda0d0c14159a1c6d4c38449bf
7
+ data.tar.gz: 34901f643a2ab6d5b6fdc51e3fd50f1764dab80fe56855ec8f26545558ade0d6209602630bceb37a6491e8123695be31117e023866c0355c5e0e8819ca020138
@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
4
4
 
5
5
  ## [Unreleased]
6
6
 
7
+ ## [0.2.8] - 2020-06-2
8
+
9
+ ### Added
10
+
11
+ - Put troubleshooting into documentation
12
+
13
+ ### Changed
14
+
15
+ - Contact layout now don't have a pre-defined contact form
16
+
7
17
  ## [0.2.6] - 2020-05-27
8
18
 
9
19
  ### Changed
@@ -51,7 +61,8 @@ All notable changes to this project will be documented in this file.
51
61
  - Unnecessary files from Jekyll build/serve
52
62
 
53
63
 
54
- [unreleased]: https://github.com/oAGoulart/vitrina/compare/v0.2.6...HEAD
64
+ [unreleased]: https://github.com/oAGoulart/vitrina/compare/v0.2.8...HEAD
65
+ [0.2.8]: https://github.com/oAGoulart/vitrina/releases/tag/v0.2.8
55
66
  [0.2.6]: https://github.com/oAGoulart/vitrina/releases/tag/v0.2.6
56
67
  [0.2.5]: https://github.com/oAGoulart/vitrina/releases/tag/v0.2.5
57
68
  [0.2.4]: https://github.com/oAGoulart/vitrina/releases/tag/v0.2.4
data/README.md CHANGED
@@ -20,6 +20,7 @@ This theme was made with the purpose of being able to generate a site just by ed
20
20
  - [Resume page layout](#resume-page-layout)
21
21
  - [Structure content](#structure-content)
22
22
  - [Links](#links)
23
+ + [Troubleshooting](#troubleshooting)
23
24
  + [Contributions](#contributions)
24
25
 
25
26
  # Usage
@@ -399,6 +400,99 @@ The links `_data/links.json` are used to generate contact information for the co
399
400
  ]
400
401
  ```
401
402
 
403
+ # Troubleshooting
404
+
405
+ These are some known issues that you may encouter:
406
+
407
+ **Using this theme with GitHub Pages**
408
+ ---
409
+
410
+ > GitHub Pages have strict rules for which Jekyll plugins can be used
411
+ > with that being said [they do permit the use of any Jekyll themes publicly hosted on GitHub](https://github.blog/2017-11-29-use-any-theme-with-github-pages/)
412
+ > to use this theme with GitHub pages add the `remote_theme` config to your `_config.json` with the `oAGoulart/vitrina` value
413
+
414
+ ```yaml
415
+ remote_theme: oAGoulart/vitrina
416
+ theme: vitrina
417
+ ```
418
+
419
+ **Customizing this theme with SCSS**
420
+ ---
421
+
422
+ > to change the theme looks you need to create a file called `assets/css/styles.scss`
423
+ > then use the template below to add your own styles
424
+
425
+ ```scss
426
+ ---
427
+ ---
428
+ @charset "utf-8";
429
+
430
+ // this is the default values for color and font
431
+ @import "customize.scss";
432
+ // ... you can change those and put here your own ...
433
+ // an example would be changing the primary color:
434
+ // $primary: white;
435
+ // that would make all elements that use that color white.
436
+ // you could also use variables:
437
+ // $primary: $white;
438
+
439
+ // these are third party libraries
440
+ @import "_bulma.scss";
441
+ @import "_fork_awesome.scss";
442
+
443
+ // these are the actual theme styles for the elements
444
+ @import "elements.scss";
445
+ @import "code.scss";
446
+ ```
447
+
448
+ **ForkAwesome icons font not found**
449
+ ---
450
+
451
+ > this issue is caused if you do not have the `fork-awesome` node package located under `node_modules/fork-awesome`
452
+ > to fix this you should add `fork-awesome` as a dependency and install it using Yarn
453
+ > also you can download and extract it inside that folder if you prefer
454
+
455
+ ```json
456
+ "dependencies": {
457
+ "fork-awesome": "^1.1.7"
458
+ }
459
+ ```
460
+
461
+ **No repo name found. Specify using PAGES_REPO_NWO environment variables, 'repository' in your configuration, or set up an 'origin' git remote pointing to your github.com repository.**
462
+ ---
463
+
464
+ > this is caused if you don't have a **GitHub** repository setup
465
+ > it is necessary when using `github-pages` gem
466
+
467
+ ```rb
468
+ gem 'github-pages', group: :jekyll_plugins
469
+ ```
470
+
471
+ **Unknown tag 'seo' included in /_layouts/default.html**
472
+ ---
473
+
474
+ > this issue is caused when the plugin `jekyll-seo-tag` is not specified at `_config.json`
475
+
476
+ ```yaml
477
+ plugins:
478
+ - jekyll-seo-tag
479
+ ```
480
+
481
+ **Blank page even when using layouts**
482
+ ---
483
+
484
+ > generally caused by the lack of the `_data` folder and its files
485
+ > also, the contact layout does not have a pre-defined contact form, take a look at `contact.md` for an example
486
+
487
+ ```
488
+ .
489
+ ├── _data
490
+ │ ├── general.json
491
+ │ ├── home.json
492
+ │ ├── links.json
493
+ │ ├── resume.json
494
+ ```
495
+
402
496
  ---
403
497
 
404
498
  # Contributions
@@ -2,8 +2,6 @@
2
2
  layout: default
3
3
  ---
4
4
 
5
- {{ content }}
6
-
7
5
  <div class="contacts">
8
6
  <h1 class="title is-size-1 has-text-centered has-text-primary">{{ page.title }}</h1>
9
7
  <div class="section section-card">
@@ -26,54 +24,8 @@ layout: default
26
24
  </p> {% comment %} links {% endcomment %}
27
25
  </div>
28
26
  <div class="column has-text-dark">
29
- <h1 class="is-size-2">Get in touch!</h1>
30
- <p>Use the form below to send me a message.</p>
31
- <form name="contact">
32
- <div class="field">
33
- <label class="label">Name</label>
34
- <div class="control">
35
- <input class="input" type="text" name="name" placeholder="e.g. Vitrina" required>
36
- </div>
37
- </div>
38
- <div class="field">
39
- <label class="label">Email</label>
40
- <div class="control has-icons-left">
41
- <input class="input" type="email" name="email" placeholder="e.g. vitrina@example.com" required>
42
- <span class="icon is-small is-left">
43
- <i class="fa fa-envelope"></i>
44
- </span>
45
- </div>
46
- </div>
47
- <div class="field">
48
- <label class="label">Subject</label>
49
- <div class="control">
50
- <input class="input" type="text" name="subject" placeholder="Message subject..." required>
51
- </div>
52
- </div>
53
- <div class="field">
54
- <label class="label">Message</label>
55
- <div class="control">
56
- <textarea class="textarea" name="message" placeholder="Message contents..." required></textarea>
57
- </div>
58
- </div>
59
- <div class="field">
60
- <div class="control">
61
- <label class="checkbox">
62
- <input type="checkbox" name="terms" required>
63
- I agree to the <a href="#">terms and conditions</a>
64
- </label>
65
- </div>
66
- </div>
67
- <div class="field is-grouped">
68
- <div class="control">
69
- <input type="submit" class="button is-primary" value="Submit">
70
- </div>
71
- <div class="control">
72
- <input type="reset" class="button is-link is-light" value="Cancel">
73
- </div>
74
- </div>
75
- </div>
76
- </form>
27
+ {{ content }}
28
+ </div>
77
29
  </div>
78
30
  </div>
79
31
  </div>
data/contact.md CHANGED
@@ -2,3 +2,51 @@
2
2
  layout: contact
3
3
  title: Contact
4
4
  ---
5
+
6
+ <h1 class="is-size-2">Get in touch!</h1>
7
+ <p>Use the form below to send me a message.</p>
8
+ <form name="contact">
9
+ <div class="field">
10
+ <label class="label">Name</label>
11
+ <div class="control">
12
+ <input class="input" type="text" name="name" placeholder="e.g. Vitrina" required>
13
+ </div>
14
+ </div>
15
+ <div class="field">
16
+ <label class="label">Email</label>
17
+ <div class="control has-icons-left">
18
+ <input class="input" type="email" name="email" placeholder="e.g. vitrina@example.com" required>
19
+ <span class="icon is-small is-left">
20
+ <i class="fa fa-envelope"></i>
21
+ </span>
22
+ </div>
23
+ </div>
24
+ <div class="field">
25
+ <label class="label">Subject</label>
26
+ <div class="control">
27
+ <input class="input" type="text" name="subject" placeholder="Message subject..." required>
28
+ </div>
29
+ </div>
30
+ <div class="field">
31
+ <label class="label">Message</label>
32
+ <div class="control">
33
+ <textarea class="textarea" name="message" placeholder="Message contents..." required></textarea>
34
+ </div>
35
+ </div>
36
+ <div class="field">
37
+ <div class="control">
38
+ <label class="checkbox">
39
+ <input type="checkbox" name="terms" required>
40
+ I agree to the <a href="#">terms and conditions</a>
41
+ </label>
42
+ </div>
43
+ </div>
44
+ <div class="field is-grouped">
45
+ <div class="control">
46
+ <input type="submit" class="button is-primary" value="Submit">
47
+ </div>
48
+ <div class="control">
49
+ <input type="reset" class="button is-link is-light" value="Cancel">
50
+ </div>
51
+ </div>
52
+ </form>
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vitrina",
3
- "version": "0.2.6",
3
+ "version": "0.2.8",
4
4
  "description": "A general purpose, configurable, Jekyll theme",
5
5
  "main": "index.html",
6
6
  "author": {
@@ -2,7 +2,7 @@
2
2
 
3
3
  Gem::Specification.new do |s|
4
4
  s.name = 'vitrina'
5
- s.version = '0.2.6'
5
+ s.version = '0.2.8'
6
6
  s.authors = ['Augusto Goulart']
7
7
  s.email = ['josegoulart.aluno@unipampa.edu.br']
8
8
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: vitrina
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.6
4
+ version: 0.2.8
5
5
  platform: ruby
6
6
  authors:
7
7
  - Augusto Goulart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-05-27 00:00:00.000000000 Z
11
+ date: 2020-06-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: github-pages