https://github.com/zfett/jekyll-creative-commons-badge

A modular Jekyll include for displaying Creative Commons license badges.
https://github.com/zfett/jekyll-creative-commons-badge

badge creative-commons include includes jekyll

Last synced: 11 days ago
JSON representation

A modular Jekyll include for displaying Creative Commons license badges.

• Host: GitHub
• URL: https://github.com/zfett/jekyll-creative-commons-badge
• Owner: zfett
• License: mit
• Created: 2024-07-08T03:19:34.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-09T03:43:24.000Z (4 months ago)
• Last Synced: 2024-09-26T11:09:32.854Z (about 2 months ago)
• Topics: badge, creative-commons, include, includes, jekyll
• Language: HTML
• Homepage:
• Size: 15.6 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# jekyll-creative-commons-badge

A modular Jekyll include for displaying Creative Commons license badges.

## How to use

- Place the `creative-commons.html` file in your Jekyll `_includes` folder.

- Place either the `creative-commons.css` or the minified `creative-commons.min.css` stylesheets wherever you host your CSS files.

- Import the CSS files wherever you plan on using the include, either before the closing `` tag or directly before the include.

- Implement the badge by placing the include where you want to use it. (ex. `{% include creative-commons.html %}`)

The badge icons are provided courtesy of [Creative Commons](https://creativecommons.org/share-your-work/). No external imports or local storage of image files are required: the SVG files were converted to base64 encoded data URIs and are used in the CSS files directly.

### Include parameters

The badge include has two parameters: `terms` and `url`. The `terms` parameter is required and helps define the badges to use and the optional `url` parameter should be a link to the terms of the license.

The `terms` parameter has the following available strings:

- `by`: Attribution

- `nc`: Non-commercial

- `sa`: Share-alike

- `nd`: No derivitives

- `zero`: CC0 - public domain

To use these strings for the `terms` parameter, separate them by a space (eg. `terms="by nc sa"`)

#### Examples

Display a badge for the Creative Commons BY-NC-SA license:

```liquid

{% include creative-commons.html terms="by nc sa" url="https://creativecommons.org/licenses/by-nc-sa/4.0/" %}

```

... or the CC0 (public domain) license:

```liquid

{% include creative-commons.html terms="zero" url="https://creativecommons.org/publicdomain/zero/1.0/" %}

```