https://github.com/getpelican/pelican-themes

Themes for Pelican
https://github.com/getpelican/pelican-themes

Last synced: 2 days ago
JSON representation

Themes for Pelican

• Host: GitHub
• URL: https://github.com/getpelican/pelican-themes
• Owner: getpelican
• Created: 2011-02-01T19:44:02.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2024-07-30T07:39:24.000Z (5 months ago)
• Last Synced: 2024-12-03T10:05:41.812Z (9 days ago)
• Language: CSS
• Homepage: https://getpelican.com/
• Size: 31.9 MB
• Stars: 2,130
• Watchers: 63
• Forks: 1,088
• Open Issues: 115
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

• awesome-pelican - Pelican Theme Repository
• awesome-starred - getpelican/pelican-themes - Themes for Pelican (others)

README

        
Pelican Themes

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

This repository contains themes for Pelican. Feel free to clone, add your own

theme, and submit a pull request. It's community-managed!

A live version can be seen at http://www.pelicanthemes.com.

Using Themes

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

These instructions assume you have already read all the `Pelican documentation`_,

have a working site, and would now like to apply a non-default theme.

.. _Pelican documentation: http://docs.getpelican.com/

First, choose a location to hold your themes. For this example, we'll use the

directory ``~/pelican-themes``, but yours could be different. Clone the

``pelican-themes`` repository to that location on your local machine:

.. code-block:: sh

	git clone --recursive https://github.com/getpelican/pelican-themes ~/pelican-themes

Now you should have your ``pelican-themes`` repository stored at

``~/pelican-themes/``.

To use one of the themes, edit your Pelican settings file to include this line:

.. code-block:: python

	THEME = "/home/user/pelican-themes/theme-name"

So, for instance, to use the ``mnmlist`` theme, you would edit your settings

file to include:

.. code-block:: python

	THEME = "/home/user/pelican-themes/mnmlist"

Save the changes to your settings file and then regenerate your site by using

the Makefile you should already have set up using ``pelican-quickstart``:

.. code-block:: sh

	make html

Themes can also be specified directly via the ``-t ~/pelican-themes/theme-name``

parameter to the ``pelican`` command. If you want to edit your theme, make sure

that any edits you make are made to the copy stored in

``~/pelican-themes/theme-name``. Any changes made to

files stored in your site's ``output`` directory will be deleted the next

time you generate your site.

Generating Theme Previews

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

Generating theme previews happens automatically via a GitHub Actions workflow,

after which those previews are published to https://pelicanthemes.com.

If you want to generate previews locally on your workstation, clone the Pelican

repository (for example, to `~/projects/pelican/`), clone this repository

somewhere, change to the root directory of that clone, and follow these steps:

.. code-block:: sh

	python -m pip install pelican[markdown] shot-scraper

        mkdir _pelican

        cp -r ~/projects/pelican/samples _pelican/

        python build-theme-previews.py