Document how to add new links to author profile
- Close #299, close #332, close #360, close #365
This commit is contained in:
parent
ac09f56f14
commit
f9d277096c
@ -2,7 +2,7 @@
|
||||
title: "Configuration"
|
||||
permalink: /docs/configuration/
|
||||
excerpt: "Settings for configuring and customizing the theme."
|
||||
modified: 2016-06-03T15:13:17-04:00
|
||||
modified: 2016-06-16
|
||||
---
|
||||
|
||||
{% include base_path %}
|
||||
@ -362,6 +362,8 @@ author:
|
||||
|
||||
Social media links are all optional, include the ones you want visible. In most cases you just need to add the username. If you're unsure double check `_includes/author-profile.html` to see how the URL is constructed.
|
||||
|
||||
To add social media links not included with the theme or customize the author sidebar further, read the full [layout documentation]({{ base_path }}/docs/layouts/#author-profile).
|
||||
|
||||
## Reading Files
|
||||
|
||||
Nothing out of the ordinary here. `include` and `exclude` may be the only things you need to alter.
|
||||
|
@ -305,6 +305,71 @@ defaults:
|
||||
**Note:** To disable the author sidebar profile for a specific post or page, add `author_profile: false` to the YAML Front Matter instead.
|
||||
{: .notice--warning}
|
||||
|
||||
The theme comes pre-built with a selection of links for the most common social media networks. These are all optional and can be [assigned in `_config.yml`]({{ base_path }}/docs/configuration/).
|
||||
|
||||
To add more links you'll need to crack open [`_includes/author-profile.html`](https://github.com/mmistakes/minimal-mistakes/blob/master/_includes/author-profile.html) and make some edits.
|
||||
|
||||
Inside of `<ul class="author__urls">` you'll find `<li>` elements wrapped in Liquid conditionals. These represent each of the possible links you can currently add to the sidebar.
|
||||
|
||||
#### Example of Twitter link
|
||||
|
||||
```html
|
||||
{% raw %}{% if author.twitter %}
|
||||
<li><a href="https://twitter.com/{{ author.twitter }}"><i class="fa fa-fw fa-twitter-square" aria-hidden="true"></i> Twitter</a></li>
|
||||
{% endif %}{% endraw %}
|
||||
```
|
||||
|
||||
To add a new link you'll need three things:
|
||||
|
||||
1. A destination URL
|
||||
2. A [Font Awesome icon](http://fontawesome.io/icons/) (`fa-` class)
|
||||
3. A label for the link
|
||||
|
||||
It's up to you if you want to wrap it in a `{% raw %}{% if %} ... {% endif %}{% endraw %}`conditional and add variables to `_config.yml`. If you don't plan to change it then hard-coding the strings is perfectly acceptable.
|
||||
|
||||
Let's run through how you'd add a new link that points to a Reddit profile. Starting with the three things from above:
|
||||
|
||||
1. `https://www.reddit.com/user/username`
|
||||
2. [`fa-reddit`](http://fontawesome.io/icon/reddit/)
|
||||
3. `Reddit`
|
||||
|
||||
And plug them into the appropriate locations:
|
||||
|
||||
```html
|
||||
<li><a href="[1]"><i class="fa fa-fw [2]" aria-hidden="true"></i> [3]</a></li>
|
||||
```
|
||||
|
||||
To end up with:
|
||||
|
||||
```html
|
||||
<li><a href="https://www.reddit.com/user/username"><i class="fa fa-fw fa-reddit" aria-hidden="true"></i> Reddit</a></li>
|
||||
```
|
||||
|
||||

|
||||
|
||||
To add a touch of color to the default black (`#000`) icon a few more steps are necessary.
|
||||
|
||||
Start by opening `/assets/_scss/_utilities.scss` to the icon section (it's near the bottom). You'll want to nest a new class beneath `.social-icons` that matches the one used to declare the Font Awesome icon. In our case `.fa-reddit`.
|
||||
|
||||
Simply add a `color` declaration and the corresponding hex code and recompile `main.css` following the steps outlined in the [stylesheet documentation]({{ base_path }}/docs/stylesheets/).
|
||||
|
||||
```scss
|
||||
.social-icons {
|
||||
|
||||
.fa-reddit {
|
||||
color: #ff4500;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||

|
||||
|
||||
**ProTip:** For bonus points you can add it as a Sass `$variable` that you set in `_variables.scss` like the other ["brand" colors](http://brandcolors.net/).
|
||||
{: .notice--info}
|
||||
|
||||
**Please please please** don't submit [pull requests]({{ base_path }}/docs/contributing/) adding in support for "missing" social media links. I'm trying to keep things down to the minimum (hence the theme's name) and have no interest in merging such PRs :expressionless:.
|
||||
{: .notice--warning}
|
||||
|
||||
### Custom Sidebar Content
|
||||
|
||||
Blocks of content can be added by using the following under `sidebar`:
|
||||
|
BIN
images/mm-author-profile-reddit-color.png
Normal file
BIN
images/mm-author-profile-reddit-color.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 16 KiB |
BIN
images/mm-author-profile-reddit-gs.png
Normal file
BIN
images/mm-author-profile-reddit-gs.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 23 KiB |
Loading…
Reference in New Issue
Block a user