Kura Eevee Save

A Material Design theme for the Pelican static site generator.

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 <https://kura.gg/eevee/>__ for more information.

Features

  • Built around Google's Material Design <https://material.google.com/>__ specification on top of Goole's Material Design Lite library <https://github.com/google/material-design-lite>__,
  • 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 <https://disqus.com/>__ or Muut <https://muut.com/>__ (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 <https://webassets.readthedocs.io/en/latest/>__, cssmin and jsmin (see Plugin: Minimise CSS and JavaScript_),
  • analytics from Google Analytics <https://analytics.google.com>, Piwik <https://piwik.org/>, GoSquared <https://www.gosquared.com/>__ and Open Web Analytics <http://www.openwebanalytics.com/>__ (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 <https://en.wikipedia.org/wiki/Microdata_(HTML)>__,
  • Aria <https://en.wikipedia.org/wiki/WAI-ARIA>__ accessibility,
  • includes Material Icons <https://design.google.com/icons/>, Font Awesome <http://fontawesome.io/> and Google's Roboto font <https://typecast.com/preview/google/Roboto>__ and,
  • seamless feature upgrade with Material Design Lite's Javascript library <https://getmdl.io/started/index.html#download>__.

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 <https://github.com/getpelican/pelican-plugins/tree/master/assets>__ (see Plugin: Minimise CSS and JavaScript_ section for more information),
  • extract_toc <https://github.com/getpelican/pelican-plugins/tree/master/extract_toc>__ ( see Table of contents for articles and pages_ section for more information),
  • headerid <https://github.com/getpelican/pelican-plugins/tree/master/headerid>__ (see Plugin: Permalinks in headlines_ section for more information),
  • lightbox <https://github.com/kura/lightbox>__,
  • neighbors <https://github.com/getpelican/pelican-plugins/tree/master/neighbors>__,
  • related_posts <https://github.com/getpelican/pelican-plugins/tree/master/related_posts>__ (see Plugin: Related articles_ section for more information),
  • series <https://github.com/getpelican/pelican-plugins/tree/master/series>__ (see Plugin: Articles in a series_ section for more information) and,
  • tipue_search <https://github.com/getpelican/pelican-plugins/tree/master/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

Open Source Agenda is not affiliated with "Kura Eevee" Project. README Source: kura/eevee
Stars
44
Open Issues
1
Last Commit
2 years ago
Repository
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating