Giter Site home page Giter Site logo

pelican-svbhack's Introduction

SVBHACK

pelican-svbhack is a responsive theme for Pelican, it is my hack of a svbtle-like theme.

DEMO

You can see the theme in action.

theme screenshot

FEATURES

  • responsive
  • syntax highlighting for pre blocks
  • supports google analytics and matomo
  • custom list of links
  • supports the readtime plugin

KNOWN ISSUES

  • no IE testing
  • no custom menu

INSTALL

Clone the repository, edit your pelicanconf.py and modify the THEME variable to make it point to the downloaded theme location.

PELICANCONF.PY

Supports a number of common global variables but patches are welcomed if you need better support.

  • GOOGLE_ANALYTICS to use Google Analytics, set this var to your UA-XYZ code

  • MATOMO_URL to use Matomo, set this var to your server, e.g. "analytics.example.com" (no protocol prefix)

  • MATOMO_SITE_ID to use Matomo, set this var to your site ID, e.g. "1"

  • USER_LOGO_URL to replace the logo placeholder, put your logo in content/images/your_logo.png and make this var point to SITEURL + '/static/images/your_logo.png'

  • ROUND_USER_LOGO set this to True to crop your logo to a circle and add a black border

  • HIDE_USER_LOGO set this to True to hide the placeholder without adding your logo

  • USE_GENERIC_FONT_FAMILIES set this to True to use generic font families and avoid using Google Fonts

  • DISQUS_SITENAME set this to your Disqus sitename to enable disqus comments in articles

  • TAGLINE some text rendered right below the logo

  • INTERNET_DEFENSE_LEAGUE set this to True if you want to enable the Internet Defense League code

When developing locally, you may want to set the following variable: SITEURL = http://localhost:8000

MODIFICATIONS

  • Accent color can be changed by editing @accent in ./static/css/style.less.
  • A different Pygmentize theme can be used by editing ./Makefile and running make pygments.

AUTHOR

pelican-svbhack is authored by Giulio Fidente.

LICENSE

Released under MIT License, full details in LICENSE file.

pelican-svbhack's People

Contributors

epistrephein avatar gfidente avatar harterrt avatar pr0ps avatar squeuei avatar ssfrr avatar vmiklos avatar xqwzts avatar zaitcev avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

pelican-svbhack's Issues

Add "Continue Reading" button

Add "Continue Reading" button at the bottom of each blog summary in the index page so it is consistent with svbtle. It's also a strong visual cue that clearly marks the end of a post summary.

I can take a stab at it if everyone thinks the feature is worthy.

Example

Set static page as homepage

I used the documentation example here to set a sample page as my homepage. However, it still has the "Return to Index" button at the bottom. This is not expected.

In Pelican >= 4.0 the format() command needs explicit keyword arguments

For example, in category.html:

{% block head %}
{% if CATEGORY_FEED_ATOM %}
<link href="{{ FEED_DOMAIN }}/{{ CATEGORY_FEED_ATOM|format(category.slug) }}" type="application/atom+xml" rel="alternate" title="{{ SITENAME }} {{ category }} Category Atom" />
{% endif %}
{% if CATEGORY_FEED_RSS %}
<link href="{{ FEED_DOMAIN }}/{{ CATEGORY_FEED_RSS|format(category.slug) }}" type="application/rss+xml" rel="alternate" title="{{ SITENAME }} {{ category }} Category RSS" />
{% endif %}
{% endblock %}

format(category.slug) needs to be format(slug=category.slug)

Pages not linking back to home page

Thanks for a great theme! One little snag, though...

When I am on a Page in the site, and I click the site title, site logo image or the "Index" link in "Index:Archives", instead of taking me back to the home page, it takes me to a "Directory listing for /pages/" and lists the three pages I have on the site.

However, if I am on an article page, I can click on the site title, site logo image or the "Index" link in "Index: Archives", and it'll take me back to the home page, as I'd expect.

I am not getting this problem when I switch back to the default theme Pelican ships with. How can I fix this? I really like this theme, but don't want my site visitors to get lost.

best practice using {% block header %}{% endblock header %}

Thanks for the great template.

I am brand new to Pelican and not sure how it picks up custom template modifications using additional files. I moved the row of links to the ending_message div and entered a string literal in its place shown here.

I tried adding header.html to the template directory
{% extends "base.html" %} {% block header %}<h1>something to bark at</h1>}{% endblock header%}

I think I need to tell Pelican to recognize the new file?

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.