The old Pelican theme I used to use for mcol.xyz
git clone https://mcol.xyz/code/rice-theme
Log | Files | Refs | README

readme.rst (2091B)


      1 rice - pelican theme
      2 ====================
      3 
      4 This is the Pelican theme that I use for mcol.xyz, where it can be seen.
      5 
      6 Almost everything can be configured in the pelicanconf.py file, with the
      7 exception of CSS colour variables that are pretty much hard-coded into
      8 static/css/main.css.
      9 
     10 
     11 variables
     12 ---------
     13 
     14 Standard variables
     15 ''''''''''''''''''
     16 
     17  - SITENAME
     18  - AUTHOR
     19  - CSS_FILE
     20  - MENUITEMS
     21  - SITESUBTITLE
     22  - DEFAULT_METADATA
     23  - FEED_ATOM
     24  - FEED_RSS
     25  - CATEGORY_FEED_ATOM
     26  - CATEGORY_FEED_RSS
     27  - FEED_DOMAIN
     28  - DISPLAY_CATEGORIES_ON_MENU
     29 
     30 
     31 Non-standard variables
     32 ''''''''''''''''''''''
     33 
     34 .. table::
     35    :widths: auto
     36 
     37    ========== =======================
     38    BLOGROLL   A list of lists, where each inner list has 3 elements in the order: name, full URL (link), short URL (text). This will be rendered below the content on a page using the blogroll template.
     39 
     40    EXTRAHEAD (string) Extra headers to add to every page verbatim.
     41 
     42    MENUPADTO  (int) Width to space-pad menu items to. Set this to the length of the largest item.
     43 
     44    ICONITEMS  (list/tuple) Class-link pairs used to add icons to the menu windows (see below).
     45 
     46    PRIVACYPOLICY  (string) Privacy policy text. If set, the word 'privacy' will be displayed at the bottom of the page and this text will be shown when it is hovered.
     47    ========== =======================
     48 
     49 
     50 menu
     51 ----
     52 
     53 The menu contains these items in this order:
     54  - Home page
     55  - Archives page
     56  - MENUITEMS items if defined
     57  - Category links if DISPLAY_CATEGORIES_ON_MENU
     58 
     59 Beside the main text links on the menu are icon links. ICONITEMS should be a
     60 tuple of class-link pairs, where the classes are added to the link's class list
     61 and can be used for styling. For example, the pelican-minify-fontawesome_
     62 plugin can be used to add Font Awesome icons. Example usage:
     63 
     64 .. code-block:: python
     65 
     66     ICONITEMS = (
     67         ('fab fa-mastodon', 'https://your.mastodon.instance/@handle" rel="me'),
     68         ('fas fa-envelope', 'mailto:your@email.address'),
     69         ('fas fa-rss', '/rss.xml'),
     70     )
     71 
     72 .. _pelican-minify-fontawesome: https://mcol.xyz/code/pelican-minify-fontawesome