Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor _config.yml to add site specific configurations (url pattern, icon class, etc.) #21

Merged
merged 9 commits into from
Feb 6, 2019

Conversation

vivekkrish
Copy link
Contributor

This PR refactors _config.yml to enable users to configure each site link based on a templated URL pattern and custom icon class for rendering.

The configuration is now controlled via a data structure stored within _config.yml, which follows the rules outlined below:

# Yaml manifest of supported social links
# Requirements:
# `name`
#     - plain-text name of the site (e.g. twitter)
#     - **mandatory**
# `url-pattern`
#     - site URL pattern containing a placeholder string (e.g. twitter.com/__USERNAME__)
#     - placeholder will be replaced by username or value specified in _config.yml (e.g. twitter.com/mytwitter)
#     - **mandatory**
# `url-scheme`
#     - the hardcoded URI/URN url-scheme (e.g. https://)
#     - can be one of: ['https://', 'http://', 'mailto:']
#     - defaults to '//'
#     - **optional**
# `icon-class`
#     - the font awesome icon class names

Additionally, a social-links-order: [] array allows users to re-order the links according to their desire.

@vivekkrish vivekkrish changed the title Rrefactor _config.yml to add site specific configurations (url pattern, icon class, etc.) Refactor _config.yml to add site specific configurations (url pattern, icon class, etc.) Feb 2, 2019
@vivekkrish vivekkrish mentioned this pull request Feb 2, 2019
4 tasks
@epidrome epidrome merged commit a723163 into epidrome:gh-pages Feb 6, 2019
@vivekkrish vivekkrish deleted the feature/refactor-config-yml branch May 24, 2019 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants