Skip to content

Latest commit

 

History

History
132 lines (103 loc) · 3.5 KB

README.md

File metadata and controls

132 lines (103 loc) · 3.5 KB
Raw

Pelican Atom Theme

A responsive theme inspired by the VSCode and Atom. Render of the Atom theme

TODOs

  • Investigate comment support, consider Isso
  • Add archives, author, authors and period_archives templates
  • Support for translations
  • Update link/text to Atom theme in the bottom
  • Move ASCII art picture out of the config file
  • Option to include image instead of ASCII art
  • Clean up JavaScript code
  • Remove the need for jQuery
  • Finish social media meta X and open_graph
  • Support blog images
  • Support pagination
  • Share options bellow post
  • Option to use fa-icon for logo in the header
  • Add option to use a regular image for the logo in the header
  • Support FEEDS

Installation

  • plugins:
    • pelican-share-post
    • ...

Settings

AUTHOR = 'Author'
SITENAME = 'Atom'
SITEURL = 'http://localhost:8000/'
HEADLINE = 'Atom Theme'
TIMEZONE = 'Europe/Amsterdam'
DEFAULT_LANG = 'En'
DEFAULT_PAGINATION = 10

# meta data description
DESCRIPTION = "hello world"

# Note that the key of this dict are the font-awesome classnames
SOCIALS = {
    'github': 'https://github.com/frankcorneliusmartin',
    'linkedin': 'https://www.linkedin.com/in/frankcorneliusmartin',
    'facebook': None,
    'pinterest': None
}

THEME =  Path('.') / 'atom'

STATIC_PATHS = ['images', 'extra/CNAME']

EXTRA_PATH_METADATA = {
    'extra/CNAME': {'path': 'CNAME'},
    'extra/robots.txt': {'path': 'robots.txt'},
    # expects a folder containing several files generated at:
    # https://favicon.io/favicon-converter/
    'images/favicon': {'path': 'favicon/'}
}

# Disable the use of tags, these are shown for each post on the index
# pages (e.g home and the tags page) and shown above each post on the
# post page.
SHOW_TAGS = True

# Disable the use of categories, these are shown for each post on the
# index pages (e.g home and the tags page) and shown above each post on
# the post page.
SHOW_CATEGORIE = True

# Setting this to true wil display the site name in the header next to
# the logo
DISLAY_SITE_NAME_IN_HEADER = True

# In case you have a ASCII are image you want to use. To generate one
# see https://franky.codes/ascii-picture.html. As alternative it is
# possible to provide a regular image. Make sure the dimensions of the
# ASCII picture are 220x220.
with open('content/extra/me.txt', 'r') as f:
    ASCII_PICTURE = f.read()

# In case you want a regular picture
PICTURE = 'images/me.jpg'

# Show cover pictures in the blog index. This requires the use of the
# `cover`` metadata in the post.
SHOW_COVERS = True

# Convert the cover images to grayscale. Options are:
# - 'grayscale'
# - 'grayscale-50'
# - 'grayscale-75'
# - 'opacity'
COVER_FILTER = 'opacity'

# By default the 32x32 favicon is used. In case you want to use a
# different one, provide the path to a (square) image.
# MENU_ICON = 'images/me.jpg'

# In case you want a font-awesome icon to be displayed next to the menu
# item, provide the name of the icon here.
# FA_MENU_ICON = 'home'

MENU_ITEMS = (
    ('Blog', SITEURL),
    ('Curriculum Vitae', f'{SITEURL}/pages/curriculum-vitae.html'),
    ('Topics', f'{SITEURL}/{TAGS_URL}'),
    ('Categories', f'{SITEURL}/{CATEGORIES_URL}'),
)

# Code blocks line numbering
PYGMENTS_RST_OPTIONS = {'linenos': 'table'}

# Feed generation
FEED_ALL_ATOM = 'feeds/all.atom.xml'
FEED_ALL_RSS = 'feeds/all.rss.xml'

Generate Articles

Styling Options

TODO:

  • cv items
  • rows of images
  • code blocks
  • toggle container