Git Product home page Git Product logo

golink's Introduction

Gem Version Build Status security

Go!link is a minimal theme for Jekyll, especially for those who want to have a page only to redirect links to other addresses.

Go!Link Theme

Table of Contents

Feature

  • Responsive
  • Google Analytics
  • Google Fonts
  • Avatar
  • 404 Error Page

Used plugins:

Requeriments

Requerid How to check How to install
ruby ruby -v Ruby
git git --version Git
gem gem -v Ruby contains Gem
bundler bundler -v gem install bundler
jekyll jekyll -v Jekyll
rake rake --version gem install rake
colorize gem list colorize gem install colorize

Usage and Install

1 - Install theme Go!Link:

$ gem install golink

2 - In an empty directory, start the structure for the theme 'Go!Link'.

$ golink init

3 - Run the command below to install the required plugins for Go! Link.

$ bundle install

4 - Ready! Now, you can run a test running the Jekyll server:

$ bundle exec jekyll serve

Custom Appearance

Now that the 'Go!Link' is functional, just put your information to leave it with your preference.

The settings are contained in the file '_data/dbase.yml'. In this file you must change the values according to your need.

The avatar for your new website must be inside the folder 'assets/images/avatar' and the favicon image, it must be in 'assets/images/favicon'.

The file '404.md' is the Error 404 page, if you enter the wrong address of your site, you will be redirected to this page. Of the same, contains text that will be displayed on the page, you can edit it as you want. In the header, you can edit the title and button values.

Deploy

Your site will be generated in the _site folder. Deploy these files to your hosting server.

Note: Before deploying to the server, you have to edit the Variables: url and baseurl in the _config.yml file according to url Where your site is crooked. You can get more information on how to set up at: Jekyll Configuration

Demo

If you want to see the project in action, go here > Demo

Questions

Make your opinions on Typing Jekyll Template, in: Go!Link - Issues

Versions

You can view and download the versions in RubyGems

License and Copyrights

License: MIT License (MIT)

Copyrights: William C. Canin | Copyright © 2017

You can change the structure of Go!Link as you wish, as long as you do not manipulate the copyrights of William C.Canin in the project

Credits

golink's People

Contributors

williamcanin avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

golink's Issues

Accessibility errors found in your template

The user @carlsonsantana validate your site template "https://williamcanin.me/golink/" and found these accessibility errors:

  • Page https://williamcanin.me/golink/:
    • Issue 9c27f8b3-66d1-4ebd-9c39-78a366179b50:
      • Type: Error
      • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
      • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.87:1. Recommendation: change text colour to #6a7791.
      • Selector: html > body > div > div:nth-child(2) > div > div > div:nth-child(3) > span > a:nth-child(2)
      • Context: <a href="https://github.com/williamcanin/golink" target="_blank">Golink</a>
    • Issue 94ee5afc-f4c4-49e3-8518-ee4ee15acbcb:
      • Type: Error
      • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
      • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.87:1. Recommendation: change text colour to #6a7791.
      • Selector: html > body > div > div:nth-child(2) > div > div > div:nth-child(3) > span > a:nth-child(1)
      • Context: <a href="https://jekyllrb.com" target="_blank">Jekyll</a>

You can check these accessibility errors using pa11y.
You can view the full validation results in our website.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.