diff --git a/CHANGELOG.md b/CHANGELOG.md index 400ae40..17f3c96 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file. ## [Unreleased] +## [0.2.8] - 2020-06-2 + +### Added + +- Put troubleshooting into documentation + +### Changed + +- Contact layout now don't have a pre-defined contact form + ## [0.2.6] - 2020-05-27 ### Changed @@ -51,7 +61,8 @@ All notable changes to this project will be documented in this file. - Unnecessary files from Jekyll build/serve -[unreleased]: https://github.com/oAGoulart/vitrina/compare/v0.2.6...HEAD +[unreleased]: https://github.com/oAGoulart/vitrina/compare/v0.2.8...HEAD +[0.2.8]: https://github.com/oAGoulart/vitrina/releases/tag/v0.2.8 [0.2.6]: https://github.com/oAGoulart/vitrina/releases/tag/v0.2.6 [0.2.5]: https://github.com/oAGoulart/vitrina/releases/tag/v0.2.5 [0.2.4]: https://github.com/oAGoulart/vitrina/releases/tag/v0.2.4 diff --git a/README.md b/README.md index c299662..c30fef2 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ This theme was made with the purpose of being able to generate a site just by ed - [Resume page layout](#resume-page-layout) - [Structure content](#structure-content) - [Links](#links) ++ [Troubleshooting](#troubleshooting) + [Contributions](#contributions) # Usage @@ -399,6 +400,99 @@ The links `_data/links.json` are used to generate contact information for the co ] ``` +# Troubleshooting + +These are some known issues that you may encouter: + +**Using this theme with GitHub Pages** +--- + +> GitHub Pages have strict rules for which Jekyll plugins can be used +> 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/) +> to use this theme with GitHub pages add the `remote_theme` config to your `_config.json` with the `oAGoulart/vitrina` value + +```yaml +remote_theme: oAGoulart/vitrina +theme: vitrina +``` + +**Customizing this theme with SCSS** +--- + +> to change the theme looks you need to create a file called `assets/css/styles.scss` +> then use the template below to add your own styles + +```scss +--- +--- +@charset "utf-8"; + +// this is the default values for color and font +@import "customize.scss"; +// ... you can change those and put here your own ... +// an example would be changing the primary color: +// $primary: white; +// that would make all elements that use that color white. +// you could also use variables: +// $primary: $white; + +// these are third party libraries +@import "_bulma.scss"; +@import "_fork_awesome.scss"; + +// these are the actual theme styles for the elements +@import "elements.scss"; +@import "code.scss"; +``` + +**ForkAwesome icons font not found** +--- + +> this issue is caused if you do not have the `fork-awesome` node package located under `node_modules/fork-awesome` +> to fix this you should add `fork-awesome` as a dependency and install it using Yarn +> also you can download and extract it inside that folder if you prefer + +```json +"dependencies": { + "fork-awesome": "^1.1.7" +} +``` + +**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.** +--- + +> this is caused if you don't have a **GitHub** repository setup +> it is necessary when using `github-pages` gem + +```rb +gem 'github-pages', group: :jekyll_plugins +``` + +**Unknown tag 'seo' included in /_layouts/default.html** +--- + +> this issue is caused when the plugin `jekyll-seo-tag` is not specified at `_config.json` + +```yaml +plugins: + - jekyll-seo-tag +``` + +**Blank page even when using layouts** +--- + +> generally caused by the lack of the `_data` folder and its files +> also, the contact layout does not have a pre-defined contact form, take a look at `contact.md` for an example + +``` +. +├── _data +│ ├── general.json +│ ├── home.json +│ ├── links.json +│ ├── resume.json +``` + --- # Contributions diff --git a/_layouts/contact.html b/_layouts/contact.html index e7a6177..1c9952d 100644 --- a/_layouts/contact.html +++ b/_layouts/contact.html @@ -2,8 +2,6 @@ layout: default --- -{{ content }} -

{{ page.title }}

@@ -26,54 +24,8 @@

Links

{% comment %} links {% endcomment %}
-

Get in touch!

-

Use the form below to send me a message.

-
-
- -
- -
-
-
- -
- - - - -
-
-
- -
- -
-
-
- -
- -
-
-
-
- -
-
-
-
- -
-
- -
-
-
- + {{ content }} +
diff --git a/contact.md b/contact.md index c802dc4..21c97bc 100644 --- a/contact.md +++ b/contact.md @@ -2,3 +2,51 @@ layout: contact title: Contact --- + +

Get in touch!

+

Use the form below to send me a message.

+
+
+ +
+ +
+
+
+ +
+ + + + +
+
+
+ +
+ +
+
+
+ +
+ +
+
+
+
+ +
+
+
+
+ +
+
+ +
+
+
diff --git a/package.json b/package.json index 260dc77..3ef320a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "vitrina", - "version": "0.2.6", + "version": "0.2.8", "description": "A general purpose, configurable, Jekyll theme", "main": "index.html", "author": { diff --git a/vitrina.gemspec b/vitrina.gemspec index 037e76d..71b42f8 100644 --- a/vitrina.gemspec +++ b/vitrina.gemspec @@ -2,7 +2,7 @@ Gem::Specification.new do |s| s.name = 'vitrina' - s.version = '0.2.6' + s.version = '0.2.8' s.authors = ['Augusto Goulart'] s.email = ['josegoulart.aluno@unipampa.edu.br']