Skip to content

Commit

Permalink
Add contributor shortcode & update contributors
Browse files Browse the repository at this point in the history
* Also updated SHORTCODES.md with new shortcode
  • Loading branch information
wjwat committed Mar 26, 2022
1 parent 033bee1 commit 7e3279c
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 23 deletions.
15 changes: 12 additions & 3 deletions SHORTCODES.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ If you'd like to add your own shortcode please update this document to provide
a place for people unfamiliar with [Zola](https://www.getzola.org/) & [shortcodes](https://www.getzola.org/documentation/content/shortcodes/)
the ability to use them throughout the site.

## contributor(name=<str>, github=<str>)

Creates a bulleted item to use give credit to contributor with `name`.

#### github=

This should be a username for this contributors GitHub, but not the full URL.

## issue()

Accepts no parameters, and provides a link to the issue section on GitHub where
Expand All @@ -15,11 +23,12 @@ Accepts no parameters. Provides a stylized version of the site name to help
distinguish it from surrounding text, and provide a visual break if used in
longer pieces of text.

## repo(text=)
## repo(text=<str>)

Provides a link to the repo with a default text of `repo`.
Provides a link to the repo with a default text of `repo`, or the value passed
in as `text`.

### text=
#### text=

This parameter accepts a string which is used to provide the text in a generated
link.
Expand Down
32 changes: 12 additions & 20 deletions content/credits/contributors.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,22 @@
+++
title = "Contributors"
weight = 1
updated = 2022-03-16

# Use a shortcode for these that will include some icons/styling for names
# links
# ![GitHub](/images/github-icon.svg)
updated = 2022-03-26

# Keep this section short and to the point, please! We can adjust the layout, and
# styling but your name/display name and a link or two would be ideal. Also keep
# it generally alphabetical.
# it generally alphabetical. This may become a two-column page in the future
# if we have enough contributors to justify it.
#
# Ex:
# - Jon Smith
# - @jonsmith
# - sassyuser1
# - @sassyuser1
# - Zap Brannigan
# - @ZappyB9218
# - Jon Smith / @jonsmith
# - sassyuser1 / @sassyuser1
# - Zap Brannigan / @ZappyB9218
+++

- Alex Adamovic
- [GH: alexadamovic](https://github.com/alexadamovic)
- Brenna Lavin
- [GH: lavinbrenna](https://github.com/lavinbrenna)
- Ryan Bass
- [GH: probablynotryan](https://github.com/probablynotryan)
- Will Watkins
- [GH: wjwat](https://github.com/wjwat)
{{ contributor(name="Alex Adamovic", github="alexadamovic") }}
{{ contributor(name="Andy Plymate", github="Playmatea") }}
{{ contributor(name="Brenna Lavin", github="lavinbrenna") }}
{{ contributor(name="Ryan Bass", github="probablynotryan") }}
{{ contributor(name="William Jameson", github="wcjameson") }}
{{ contributor(name="Will W.", github="wjwat") }}
8 changes: 8 additions & 0 deletions templates/shortcodes/contributor.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<div class="contributor-info">
<p>{{ name }}
{% if github %} /
<img src="/images/github-icon.svg" style="width: 1rem" />
<a href="https://github.com/{{ github }}">{{ github }}</a>
{% endif %}
</p>
</div>

0 comments on commit 7e3279c

Please sign in to comment.