mayannaoliveira / mayannaoliveira.github.io

GitHub Pages with Jekyll and Ruby

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

EM CONTRUÇÃO - SOMENTE PARA TESTES

Installation

  1. Clone this repository.
  2. Rename it to [username].github.io.
  3. Start editing!

Usage

Configuration primarily occurs in four files. First, _config.yml, which contains site variables such as title, tagline, url, and repository address, as well as the author's name and email address for inclusion in blog posts. You can also specify the path to an avatar for inclusion in the home (optional).

Second, you should update icon links in _includes/particles-home.html and add/remove icons as needed. You might want to add icons that are not included in the theme by default. For more information on how to do this, see this post.

Third, you should customize the file _includes/contact.html by inputting your contact details and adding/removing lines as needed. This information is prepended to your CV.

Fourth, you might want to edit the style variables specified in _sass/_variables.scss. These allow you to customize the theme's color scheme and typefaces. There are many resources on the web to learn the principles of good web design. I personally recommend Matthew Butterick's Practical Typography.

In addition to these files, you can customize favicons in the assets folder. For that, favicon.io is an excellent tool. You can also change the particles.js configurations in assets/json. The library homepage features an interactive tool from which you can export a new configuration.

Local Development

This repo includes a docker-compose file that allows you to quickly setup a container running Jekyll. If you don't already have Docker and docker-compose installed, you can install them using the following guides:

Install Guides

To start the container simply run:

docker-compose up

Alternatively you can run the container without docker-compose using this command on iOS/Linux:

docker run -p 4000:4000 -v $(pwd):/site bretfisher/jekyll-serve

Credits

The theme draws in one way or another from the following projects:

About

GitHub Pages with Jekyll and Ruby

License:MIT License


Languages

Language:SCSS 47.9%Language:HTML 27.8%Language:CSS 11.8%Language:JavaScript 11.6%Language:Ruby 0.8%