vitrina

oAGoulart
3

A general purpose, configurable, Jekyll theme.

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
Troubleshooting
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):

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.

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:

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

---
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.

"style": "has-text-danger", // Bulma CSS class

icon: is any ForkAwesome icon in the following format:

"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.

The header is divided into two JSON objects, brand and menu:

brand: Has the following structure:

{
  "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.

{
  "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:

{
  "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:

{
  "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:

{
  "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 ...
  ]
}

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.

An example of footer would be:

"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.

{
  "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:

{
  "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:

{
  "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):

{
  "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:

{
  "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.

photo: A link to the resume photo.

{
  "photo": "/assets/img/icon.png", // link
}

name: The name of the resume holder.

{
  "name": "Vitrina", // name
}

title: The title of the resume holder.

{
  "title": "Malding Scientist", // title
}

skills: A list of skills bars.

{
  "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.

{
  "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.

{
  "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:

{
  "style": "is-primary",      // global attribute
  "type:" "link"              // define link element
  "content": "See my resume", // link text
  "link": "resume"            // link reference
}

image: An image:

{
  "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:

{
  "type": "text",        // define text element
  "content": "Except"    // text to be shown
}

icons: A list of icons:

{
  "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:

[     // 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 to use this theme with GitHub pages add the remote_theme config to your _config.json with the oAGoulart/vitrina value

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

---
---
@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

"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

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

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.

minimal academic resume portfolio documentation wiki tailwind bootstrap dark ecommerce github-pages blog