Skip to main content

Embed a list of your public GitHub projects in your pages

Project description

Embed a list of your public GitHub projects in your pages.

Installation

To install pelican-githubprojects, simply install it from PyPI:

$ pip install pelican-githubprojects

Configuration

Enable the plugin in your pelicanconf.py

PLUGINS = [
    # ...
    'pelican_githubprojects',
    # ...
]

Add a setting with your GitHub username.

GITHUB_USER = 'kura'

Available data

name:

The name of your project.

language:

The language your project is written in, information on how GitHub detects languages is available here. It is GitHub that detects the language, not this plugin. So please, no issues about that.

description:

The description of your project (as set on GitHub.)

homepage:

The homepage of your project (as set on GitHub.)

github_url:

The web page URL of your project on GitHub (not the GIT or API URL.)

Usage

In your templates you will be able to iterate over the github_projects variable, as below.

{% if GITHUB_USER %}
    <h1>Projects</h1>
    {% for project in github_projects %}
        <h2>{{ project.name }} <sup>({{ project.language }})</sup></h2>
        <p>{{ project.description }}</p>
        <p>
            <a href="{{ project.homepage }}">Homepage</a>
            <a href="{{ project.github_url }}">GitHub</a>
        </p>
    {% endfor %}
{% endif %}

License

MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pelican-githubprojects-0.1.1.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

pelican_githubprojects-0.1.1-py2.py3-none-any.whl (6.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pelican-githubprojects-0.1.1.tar.gz.

File metadata

File hashes

Hashes for pelican-githubprojects-0.1.1.tar.gz
Algorithm Hash digest
SHA256 339dafdfe60c6237d9924bdfc9316f3630c61aad3d769e236100dcae8740b72d
MD5 9cae840e76134021c64d0ace6e09ecc9
BLAKE2b-256 3e38e15560532881dd60c13ad014faea22db844f70a2520660ef4231d63c1e2f

See more details on using hashes here.

File details

Details for the file pelican_githubprojects-0.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pelican_githubprojects-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0959ebe29f151fe6ebe6862dea52964b8484f8ef9814413f98000bf70f707f06
MD5 54d285f639d9099aad33a71afdfa02f4
BLAKE2b-256 82eefb382cd5375826690553ff68c2959e771a0105c20d0b2ca21aab96f43242

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page