https://github.com/kura/eevee

A Material Design theme for the Pelican static site generator.
https://github.com/kura/eevee

css html5 jinja2 pelican

Last synced: 14 days ago
JSON representation

A Material Design theme for the Pelican static site generator.

• Host: GitHub
• URL: https://github.com/kura/eevee
• Owner: kura
• License: mit
• Created: 2016-06-06T01:21:19.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-08-21T18:40:07.000Z (3 months ago)
• Last Synced: 2024-10-16T10:35:22.898Z (30 days ago)
• Topics: css, html5, jinja2, pelican
• Language: HTML
• Homepage: https://kura.gg/eevee/
• Size: 7.11 MB
• Stars: 46
• Watchers: 4
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Eevee - A Material Design theme for Pelican

###########################################

.. image:: https://raw.githubusercontent.com/kura/eevee/master/eeveelutions.png

    :alt: Eevee the Pokémon

    :align: center

Please see the `official documentation `__ for more

information.

Features

========

- Built around `Google's Material Design `__

  specification on top of Goole's `Material Design Lite library

  `__,

- configurable colour scheme (see `Primary and accent colours`_),

- responsive layout with mobile friendly header and navigation scheme,

- inclusion of a ``custom.css`` file allowing easy overwriting of the theme

  without breaking the base CSS (see `Custom CSS`_),

- `DNS prefetch`_ (see `DNS prefetch`_),

- comments via `Disqus `__ or `Muut

  `__ (see `Disqus or Muut for comments`_),

- share buttons for Twitter, Facebook, email and comments (see

  `Sharing options`_),

- Twitter and Open Graph meta tags (see `Adding an image to Open Graph and

  Twitter meta tags`_),

- CSS and JS minifying via `webassets

  `__, cssmin and jsmin (see

  `Plugin: Minimise CSS and JavaScript`_),

- analytics from `Google Analytics `__,

  `Piwik `__, `GoSquared `__

  and `Open Web Analytics `__ (see

  `Google Analytics, Piwik, Open Web Analytics and GoSquared`_),

- easy customisation, including menus and footer (see `Header and footer

  options`_),

- custom 404 error page,

- `Microdata `__,

- `Aria `__ accessibility,

- includes `Material Icons `__, `Font Awesome

  `__ and Google's `Roboto font

  `__ and,

- seamless feature upgrade with Material Design Lite's `Javascript library

  `__.

Plugins supported out-of-the-box

================================

Eevee ships with all the HTML, CSS and JavaScript required for the following

plugins but does not need any of them to function correctly. If a plugin is

supported but not used, the HTML, CSS and JavaScript simply won't be included.

- `assets

  `__ (see

  `Plugin: Minimise CSS and JavaScript`_ section for more information),

- `extract_toc

  `__ (

  see `Table of contents for articles and pages`_ section for more

  information),

- `headerid

  `__ (see

  `Plugin: Permalinks in headlines`_ section for more information),

- `lightbox

  `__,

- `neighbors

  `__,

- `related_posts

  `__

  (see `Plugin: Related articles`_ section for more information),

- `series

  `__ (see

  `Plugin: Articles in a series`_ section for more information) and,

- `tipue_search

  `__ (

  see `Plugin: Search functionality`_ section for more information.)

Screenshots

===========

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/archives.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/article-header.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/disqus.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/eevee-mega-footer.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/headerid.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/homepage-separator.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/homepage.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/mobile-homepage.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/mobile-menu.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/pygments.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/related-author-card.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/search.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/series.png

.. image:: https://raw.githubusercontent.com/kura/eevee/master/screenshots/small-footer.png