To experiment with this code, add some sample content and run bundle exec jekyll serve
– this directory is setup just like a Jekyll site!
Add this line to your Jekyll site's Gemfile
:
gem "business-card-jekyll-theme", git: "https://github.com/nikolapeja6/business-card-jekyll-theme"
And add this line to your Jekyll site's _config.yml
:
theme: business-card-jekyll-theme
or, in case you are using GitHub Pages, the line should be:
remote_theme: nikolapeja6/business-card-jekyll-theme
And then execute:
bundle
from the root of the project.
Add some or all of the following settings in the _config.yml
file in order to configure your business card.
The majority of the settings are optional, while a few have predefined default values
(which can be overridden by assigning an empty string ""
as the value of that setting).
# General settings
title: Business Card theme
background:
color: rgb(43,42,51)
foreground:
color: whitesmoke
# Card info
card:
name: John Doe
titles: Software Engineer | Student
# Profiles
profiles:
github: octocat
youtube: user/YouTube
twitter: twitter
instagram: instagram
facebook: facebook
linkedin: company/linkedin
stackoverflow: 1
twitch: twitch
Note: You can take a look at the
demo
branch of this repo for an example of how to setup the theme.
Note: You can take a look at
https://nikolapeja6.github.io/business-card-jekyll-theme/
to see how the site should look like after being built.
To set up your environment to develop this theme, run bundle install
.
The theme is setup just like a normal Jekyll site! To test the theme, run bundle exec jekyll serve
and open your browser at http://localhost:4000
.
The icons used in this project are obtained form iconfinder under a "Free for commercial use" license, and can be view in this collection.
The theme is available as open source under the terms of the MIT License.