Git Product home page Git Product logo

pelican-attila-x's Introduction

Attila-X — theme for Pelican

Warning: Theme is being modified heavily at present. Things might break. This documentation is also out of date.


This is a modified version of the Pelican attila theme by Arulraj V. Original theme is made for the Ghost blogging platform by Peter Amende.

Live Demo

Features

  • Responsive
  • Automatic dark mode
  • Detailed information in author profiles including links to social media accounts
  • Social media integration — support for Twitter, Facebook, GitHub, GitLab and Mastodon links in author profile and navigation
  • Cover image support for home page, article, page and templates
  • Can be configured to support comments — currently supports Commento
  • Syntax highlight for code samples
  • Next and Previous posts beneath blog posts (requires the neighbors plugin)

Installation

  1. Unzip theme

  2. Update pelicanconf.py:

    THEME = 'themes/pelican-attila-x'
    

Configuration

The following settings can be added to pelicanconf.py in addition to the ones supported by Pelican (SITENAME, SITEURL, AUTHOR etc.,)

SITE_LOGO string

Path to website's logo relative to the content directory, for example images/logo.svg.

AUTHORS dict

Metadata for authors. At a minimum, there should be a single entry corresponding to the website's AUTHOR, for example:

AUTHOR = 'Astro'

AUTHORS = {
  'Astro' : {
    'avatar': 'images/author_profile.svg',
    'website': 'https://example.com',
    'location': 'World',
    'bio': 'Astronaut · Writer',
    'twitter': 'https://twitter.com',
    'facebook': 'https://facebook.com',
    'github': 'https://github.com',
    'gitlab': 'https://gitlab.com',
    'mastodon': 'https://mastodon.social/',
    'cover_image': 'images/author.svg'
  }
}

SOCIAL tuple of tuples

Links to social media accounts for this website:

SOCIAL = (
    ('Twitter', 'https://twitter.com/'),
    ('Facebook', 'https://facebook.com/'),
    ('Mastodon', 'https://linuxrocks.online/')
)

MENUITEMS tuple of tuples

Links to appear in site navigation:

MENUITEMS = (
    ('Home', '/'),
    ('About', '/about'),
)

COVER_IMAGES dict

Cover images to use in template pages. Keys correspond to template names.

COVER_IMAGES = {
    'index': 'images/rocket.svg',
    'authors': 'images/authors.svg',
    'archives': 'images/archives.svg',
    'categories': 'images/categories.svg',
    'period_archives': 'images/period_archives.svg',
    'tags': 'images/tags.svg',
    'category': {
        'blogging': 'images/blogging.svg'
        },
    'tag': {
        'pelican': 'images/blogging.svg'
    },
}

COLORS dict

Use an alternate color for links:

COLORS = {
    'primary': '#e63946',
}

The following settings can be added to publishconf.py


ENABLE_COMMENTO boolean

If you use Commento for comments, uncomment this setting

#ENABLE_COMMENTO = True

Support Development

If you would like to support development of this theme, you can consider making a donation on Paypal

License

MIT

pelican-attila-x's People

Contributors

vimalkvn avatar arulrajnet avatar sio avatar m0nica avatar agemanning avatar itsonlybarney avatar bdero avatar chrisdinant avatar mcminnra avatar beleriandcrises avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.