Giter Club home page Giter Club logo

elegant's Introduction

Elegant – an elegant theme for Pelican

Netlify Status Build Status code style: prettier Commitizen friendly License: MIT

Elegant is a theme for the static site generator Pelican.

It offers several unique features like search, live filter, collapsible comments, Mailchimp, custom 404 page, and many more.

It is a minimal, and stylish theme that looks amazing across all screen resolutions and devices.

Live Demo

Visit elegant.oncrashreboot.com to see theme in action, which is also home to the documentation.

Documentation

License: CC BY 4.0

Elegant is the only Pelican theme that offers comprehensive documentation.

The documentation can be viewed at elegant.oncrashreboot.com. Its source code is in documentation folder of this repository.

How to contribute

Developing Elegant is a community effort. You are invited to help develop it further.

Feel free to fork the repository, and submit pull requests.

If you find any issues, or have a suggestion, then please open an issue.

License

Elegant is released under the MIT License. See THANKS.md file for a list of contributors.

Elegant's documentation is released under the Creative Commons Attribution 4.0 International license.

All code contributions are made directly under the MIT License as well. This is commonly referred to as the "Inbound=Outbound licensing model", as the license everyone contributes their code under (i.e. inbound license) is exactly the same as the license that the code is then being released under to the general public.

elegant's People

Contributors

0x8badfood avatar allcontributors[bot] avatar ashwinvis avatar awegnergithub avatar azzamsa avatar calfzhou avatar debiatan avatar dependabot[bot] avatar gertvdijk avatar iranzo avatar jackdewinter avatar jean avatar jerith avatar knz avatar leotrs avatar maneesha avatar matthew-brett avatar osvenskan avatar semantic-release-bot avatar silverhook avatar talha131 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  avatar  avatar

elegant's Issues

What is the least intrusive way to keep table of contents of an article visible when reader scrolls down

pdhbreak started this conversation

And I love the content table on the left. If it can scroll with the page, much more useful.

That was my original plan. During beta testing prior to release of version 1.0, it turned out to be a source of distraction for the readers. So I removed it. But you are right, there should be some sort of visible navigational menu for the user when he scrolls down. I am looking for ideas. Please feel free to share your ideas here.

Use CSS to frame images

Perhaps

#article img {
    padding:5px;
    border:1px solid #969696;
    background-color:#e1e1e1;

}

some warnings related to sitemap plugin

Wanted to confirm if anyone else gets this warning, and if it's anything I should care about:

$ pelican --settings settings.py
WARNING: sitemap plugin: SITEMAP['format'] must be `txt' or `xml'
WARNING: sitemap plugin: Setting SITEMAP['format'] on `xml'
Done: Processed 274 articles and 1 pages in 43.68 seconds.

Add description about feeds

Add information about RSS feed and how they appear on every page.

Why there is no visible cue?
B/c people are not using it that much

Expose support for fontawesome

If I include font awesome to the theme then it should be exposed to the users (perhaps via documentation) so that they can use it too in their markup.

Add latex support

  • Accept patch
  • Test it
  • Attribute it to Jed Brown
  • Add documentation
diff --git i/templates/base.html w/templates/base.html
index a816ae7..d40ee1c 100644
--- i/templates/base.html
+++ w/templates/base.html
@@ -13,6 +13,12 @@
         <meta name="author" content="{{ AUTHOR }}" />
         <meta name="copyright" content="{{ AUTHOR }}" />
         {% endif %}
+        {% if article and article.latex %}
+          {{ article.latex }}
+        {% endif %}
+        {% if page and page.latex %}
+          {{ page.latex }}
+        {% endif %}

         {% if SITE_DESCRIPTION %}
         <meta name="description" content="{% block head_description %}{{ SITE_DESCRIPTION }}{% endblock head_description %}" />

Add textual social sharing links

Social sharing links are need of every blog. But Share widgets are usually a nuisance, from reading and privacy point of view.

These issues can be covered using textual links. So instead of a twitter button you will have a Share this on twitter link.

See Share Link Generator for examples.

This may require a Pelican plugin. Plugin will generate the links and add it to article attributes article.twitter, article.reddit.

Question is how will Elegant utilize this plugin. It will let user define a message.

SOCIAL_SHARING_MESSAGE = u'If you like this article please share it on FACEBOOK | TWITTER | REDDIT | HACKERNEWS.'

Elegant will replace FACEBOOK with article.facebook. If article.facebook is not defined then Elegant will not do anything.


Elegant can create URL for each social network. But lets do it in a plugin so that other themes can also use it.

Create FAQ

  1. I have enabled feed but it's icon does not appear
  2. How do I add social icon for x website
  3. How do I add RSS icon
  4. How do I get line numbers in code #14
  5. How to disable overwrapping in <pre> block #8
  6. How do I use twitter cards
  7. Why is links color so muted
  8. Stat Counter codes link
  9. I don't want to use solarized theme for code
  10. What if you don't want to use custom CSS to reduce HTTP requests

Add contribution rules

  1. CSS should follow the style
  2. Sensible defaults so that theme should work out of the box
  3. Also update project documentation
  4. User should not have to have use readability addons
  5. Use muted colors

Put update date in <time> tag

See issue #19 for discussion on it.

Now the question is should a patch be submitted to Pelican to have a datetime metadata for last-updated beside date. Otherwise Pelican treats every custom metadata as string.

Social Media Optimizer

Twitter Card. Twitter shows summary of links shared on it. How to do it so that links from sites using Elegant also get their summary shown.

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.