vitrina 0.2.4 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b640a746eb8803a2deaed2547fea62860556ca354e1c3ff294f82c8481ada4a
-  data.tar.gz: 6db6768e20e88915f2108591902e4f59e8aed40a6c7878ddba5edcf5c2b8fa0a
+  metadata.gz: e15ff8590d3ea42e43365767ffbf72af7c3b101fc9e4da1f177bc377bf5ba8c1
+  data.tar.gz: 18b91de1d114b40cabc473229c773fbab22b0c6d963f219e0bb2d8865fd4a087
 SHA512:
-  metadata.gz: ff960a163660606ef076b66213b8768d63e8ae0e3b69b1b5fdc4e4c577edb67ca79837385021b7c4b1535bf78f5257a177038dd83d8cdfd710f1c6e6b26b804f
-  data.tar.gz: 539d0681ada172ec06ec67c617cec1e5ae6e7abd1d1c135d3a6f1e9619fd77353c03e48e95762b873b7401b8209d85e2c9df52605f1b722baaa41bb876ad3ac8
+  metadata.gz: 6ee0c2b4adade449f1cba7d48b7534c27f6652fbbd0a85a92bff0f09a317fe97a6fc1a38095db16070cfb33fa957ffcd1c78a9cb656ef63d1de2fb165620fe32
+  data.tar.gz: fe2c2c7f499d7478613b7c0ef5cf596c5200d1966593f6e127053077ec4847d537ed92a0bef0ad16bbe1630b7b9f1ab94175133aea43eba13765127b5e62f4a0

data/.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_size = 2
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+patreon: AGoulart
+ko_fi: agoulart

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Report a bug that you saw or experienced
+title: "[BUG]"
+labels: bug
+assignees: oAGoulart
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here, such as development environment.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: oAGoulart
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/gempush.yml

@@ -0,0 +1,42 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,7 @@
+_site
+.sass-cache
+.jekyll-metadata
+*.lock
+*.gem
+.bundle
+vendor/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+before_script:
+  - bundle install
+script:
+  - sudo chmod +x ./scripts/build.sh
+  - ./scripts/build.sh

data/404.md

@@ -0,0 +1,5 @@
+---
+layout: error
+title: 404
+message: This page could not be found!
+---

data/CHANGELOG.md

@@ -0,0 +1,88 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [0.3.1] - 2021-01-18
+
+### Added
+
+- Projects overlay option
+
+## [0.3.0] - 2020-09-04
+
+### Changed
+
+- Bulma version to 0.9.0
+
+### Fixed
+
+- Buttons "without" link going to home page
+
+## [0.2.8] - 2020-06-02
+
+### Added
+
+- Put troubleshooting into documentation
+
+### Changed
+
+- Contact layout now don't have a pre-defined contact form
+
+## [0.2.6] - 2020-05-27
+
+### Changed
+
+- Gem files registration method
+
+## [0.2.5] - 2020-05-27
+
+### Fixed
+
+- Gem not packing all files
+
+## [0.2.4] - 2020-05-27
+
+### Fixed
+
+- Layouts not available when using as Jekyll theme
+- Background color of `main`
+
+## [0.2.2] - 2020-05-27
+
+### Added
+
+- 404 error page.
+- Screenshot image.
+
+## [0.2.0] - 2020-05-27
+
+### Added
+
+- This CHANGELOG file.
+
+### Changed
+
+- Resume page now being generated with its own JSON file.
+
+### Fixed
+
+- Resume years bar color not using color variables
+- Color of home page about section button
+- Task list style
+
+### Removed
+
+- Unnecessary files from Jekyll build/serve
+
+
+[unreleased]: https://github.com/oAGoulart/vitrina/compare/v0.3.1...HEAD
+[0.3.1]: https://github.com/oAGoulart/vitrina/releases/tag/v0.3.1
+[0.3.0]: https://github.com/oAGoulart/vitrina/releases/tag/v0.3.0
+[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
+[0.2.2]: https://github.com/oAGoulart/vitrina/releases/tag/v0.2.2
+[0.2.0]: https://github.com/oAGoulart/vitrina/releases/tag/v0.2.0

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'github-pages', group: :jekyll_plugins
+
+gem 'wdm', '~> 0.1.0' if Gem.win_platform?

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Augusto Goulart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,501 @@
+[![Vitrina](screenshot.png)]()
+
+[![Build Status](https://travis-ci.com/oAGoulart/vitrina.svg?branch=master)](https://travis-ci.com/oAGoulart/vitrina)
+[![Gem](https://img.shields.io/gem/v/vitrina)](https://rubygems.org/gems/vitrina)
+[![Gem](https://img.shields.io/gem/dt/vitrina)](https://rubygems.org/gems/vitrina)
+[![License](https://img.shields.io/badge/license-MIT-informational.svg)](https://opensource.org/licenses/MIT)
+
+A general purpose theme for Jekyll made with Bulma.
+
+This theme was made with the purpose of being able to generate a site just by editing a few JSON files, this was something I needed for creating multiple pages using scripts.
+
+# Summary
+
++ [Usage](#usage)
+  - [About the layout](#about-the-layout)
+  - [General layout](#general-layout)
+    + [Header](#header)
+    + [Footer](#footer)
+  - [Home page layout](#home-page-layout)
+  - [Resume page layout](#resume-page-layout)
+  - [Structure content](#structure-content)
+  - [Links](#links)
++ [Troubleshooting](#troubleshooting)
++ [Contributions](#contributions)
+
+# Usage
+
+You can use this theme as a template for creating another one or use it as a *Ruby* gem in your project (just like a plugin):
+
+```sh
+gem install vitrina --vendor
+```
+
+If you just want to use this theme for a web site, all you need to do is [change your Jekyll project theme](https://jekyllrb.com/docs/themes/#installing-a-theme).
+
+If you need something else the scripts inside `scripts/` may help you out.
+
+This theme may be exactly what you need or exactly what you're trying to avoid. So, if using JSON or learning this theme's layout is not what you want, here's some alternatives:
+
++ [minimal-mistakes](https://github.com/mmistakes/minimal-mistakes)
++ [beautiful-jekyll](https://github.com/daattali/beautiful-jekyll)
+
+## About the layout
+
+There are some layouts at `_layouts` which can be used to create an entire page by just making a markdown page, those include:
+
++ blog (this one uses pagination, ext. must be `.html`)
++ contact
++ error
++ home
++ papers
++ post
++ projects
++ resume
+
+```md
+---
+layout: contact
+title: Contact
+---
+```
+
+The layout is made by many elements, all elements have global attributes, while some have specific ones.
+
+Any element **CAN** have the following global attributes:
+
+`style`: any CSS class to be used for styling, can be a Bulma one.
+```jsonc
+"style": "has-text-danger", // Bulma CSS class
+```
+
+`icon`: is any ForkAwesome icon in the following format:
+```jsonc
+"icon": {
+  "style": "has-text-info", // global attribute
+  "name": "fa-feed"         // ForkAwesome icon name
+}
+```
+
+## General layout
+
+The file at `_data/general.json` can be used to change the site's navbar and footer layout.
+The `header` is a JSON `object` and the `footer` is an array, see below on how they are structured.
+
+### Header
+
+The `header` is divided into two JSON objects, `brand` and `menu`:
+
+`brand`: Has the following structure:
+```jsonc
+{
+  "brand": {
+    "name": "Brand",                 // brand name
+    "image": "assets/img/logo.png",  // path to brand logo
+    "link": ""                       // brand link
+  }
+}
+```
+
+`menu`: This is divided in two arrays `start` and `end` both are lists to elements, the first one is the left side of the navbar, while the second is the right side of the navbar.
+These arrays can have the following elements:
+
+**buttons:** A list of buttons to be generated.
+```jsonc
+{
+  "type": "buttons",                   // define this element as being of type buttons
+  "content": [                         // array of buttons
+    {
+      "style": "is-info",              // global attribute
+      "content": "Donate",             // button text
+      "link": "donate",                // button link
+      "icon": {                        // global attribute
+        "style": "has-text-success",
+        "name": "fa-money"
+      }
+    }
+  ]
+}
+```
+
+**link:** A navbar link:
+```jsonc
+{
+  "style": "has-text-light",   // global attribute
+  "type": "link",              // define this element as link
+  "content": "Blog",           // link text
+  "link": "blog",              // link reference
+  "icon": {                    // global attribute
+    "style": "has-text-info",
+    "name": "fa-feed"
+  }
+}
+
+```
+
+**text:** A text paragraph:
+```jsonc
+{
+  "style": "has-text-light",   // global attribute
+  "type": "text",              // define this element as text
+  "content": "Some potatoes",   // text to be shown
+}
+
+```
+
+**dropdown:** A dropdown with links:
+```jsonc
+{
+  "type": "dropdown",       // define dropdown element
+  "content": "More",        // dropdown name
+  "links": [                // array of links (see above)
+    {
+      "content": "Contact",
+      "link": "contact",
+    },
+    {
+      "divider": true       // navbar divider
+    }
+    // ... more links here ...
+  ]
+}
+
+```
+
+### Footer
+
+The `footer` is an array that can generate columns, to use them you need to add a Bulma style. Each column has a `content` attribute, which is an array with any elements defined in [structure content](#structure-content).
+
+An example of footer would be:
+```jsonc
+"footer": [
+  {
+    "style": "is-3",     // column of size 3 (see Bulma docs)
+    "content": [
+      // ... put elements here ...
+    ]
+  }
+  // ... put other columns here ...
+]
+```
+
+## Home page layout
+
+The home page `_data/home.json` has an array of structures. Those structures are pre-defined elements that can contain many more elements (but not other structures).
+
+**hero:** The same as a Bulma hero.
+```jsonc
+{
+  "structure": "hero",         // define this structure as a hero
+  "name": "Vitrina",           // structure name
+  "background": "potato.png",  // background image
+  "content": [
+    // ... put the elements here ...
+  ]
+}
+```
+
+**level:** A horizontal list of elements:
+```jsonc
+{
+  "structure": "level",     // define level structure
+  "content": [              // array of items array
+    {
+      "style": "some-class" // global attribute
+      "items": [            // array of elements
+        // ... put elements here ...
+      ]
+    }
+    // ... put other items arrays here ...
+  ]
+}
+```
+
+**timeline:** A timeline that can be used to display time organized cards:
+```jsonc
+{
+  "structure": "timeline",   // define timeline structure
+  "title": "Timeline",       // timeline title
+  "cards": [
+    {
+      "content": [
+        // ... put elements in here ...
+      ]
+    },
+    // ... put more cards here ...
+  ]
+}
+```
+
+**section:** A section that can be used for any kind of content (good for text):
+```jsonc
+{
+  "structure": "section",  // define section structure
+  "title": "About",        // section title
+  "content": [
+    // ... put elements in here ...
+  ]
+}
+```
+
+**grid:** A grid of cards that is similar to Pinterest's boards:
+```jsonc
+{
+  "structure": "grid",          // define the grid
+  "title": "Featured",          // grid title
+  "cards": [                    // array of cards
+    {
+      "title": "Potatoes",      // card title
+      "image": "card.png",      // card image
+      "content": [
+        // ... put any elements in here ...
+      ]
+    }
+    // ... put other cards in here ...
+  ]
+}
+```
+
+## Resume page layout
+
+The resume page `_data/resume.json` has some strict elements. Those elements are similar to the ones found in [structure content](#structure-content).
+
+**photo:** A link to the resume photo.
+```jsonc
+{
+  "photo": "/assets/img/icon.png", // link
+}
+```
+
+**name:** The name of the resume holder.
+```jsonc
+{
+  "name": "Vitrina", // name
+}
+```
+
+**title:** The title of the resume holder.
+```jsonc
+{
+  "title": "Malding Scientist", // title
+}
+```
+
+**skills:** A list of skills bars.
+```jsonc
+{
+  "skills": [
+    {
+      "icon": "fa-html5",  // skill bar icon
+      "progress": {        // progress bar
+        "value": 90,       // progress bar current value
+        "max": 100         // progress bar maximum value
+      }
+    }
+   // ... more skills here ... 
+  ]
+}
+```
+
+**profile:** A list of informational sections.
+```jsonc
+{
+  "profile": [                 // array of sections
+    {
+      "title": "Experience",   // section title
+      "info": [                // array of information
+        {
+          "years": "1001-1312",    // information year
+          "text": "Malder",        // information text
+          "list": [                // array of lines (optional)
+            {
+              "text": "Achived malding"    // line text
+            }
+            // ... more lines here ...
+          ]
+        }
+        // ... more information here ...
+      ]
+    }
+    // ... more sections here ... 
+  ]
+}
+```
+
+## Structure content
+
+The elements below can be used inside any structure and inside a few other elements:
+
+**buttons:** A list of buttons to be generated.
+```jsonc
+{
+  "type": "buttons",         // define buttons element
+  "content": [               // array of buttons
+    {
+      "style": "is-button",  // global attribute
+      "content": "See more", // button text
+      "link": ""             // button link
+    }
+    // ... put more buttons here ...
+  ]
+}
+```
+
+**link:** A link:
+```jsonc
+{
+  "style": "is-primary",      // global attribute
+  "type:" "link"              // define link element
+  "content": "See my resume", // link text
+  "link": "resume"            // link reference
+}
+```
+
+**image:** An image:
+```jsonc
+{
+  "type": "image",            // define image element
+  "name": "Made with Bulma",  // image name
+  "link": "https://bulma.io", // image link
+  "file": "bulma.png",        // image file
+  "width": "128",             // image width
+  "height": "24"              // image height
+}
+```
+
+**text:** A text paragraph:
+```jsonc
+{
+  "type": "text",        // define text element
+  "content": "Except"    // text to be shown
+}
+```
+
+**icons:** A list of icons:
+```jsonc
+{
+  "style": "is-large",         // global attribute
+  "type": "icons",             // define icons element
+  "content": [                 // icons array
+    {
+      "style": "fa-stack-2x",  // global attribute
+      "name": "fa-university"  // ForkAwesome icon
+    }
+    // ... put more icons here ...
+  ]
+}
+```
+
+## Links
+
+The links `_data/links.json` are used to generate contact information for the contact page. They are organized inside an array that can have many links organized as such:
+
+```jsonc
+[     // array
+  {
+    "reference": "https://twitter.com/",  // link reference
+    "icon": "fa-twitter"                  // link icon
+  }
+  // ... more links here ...
+]
+```
+
+# 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
+
+Feel free to leave your contribution here, I would really appreciate it!
+Also, if you have any doubts or troubles using this package just contact me or leave an issue.