From 74fb998e1df2fdb914d83e6fbc448152b8081e9b Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Sun, 28 Jul 2024 18:27:30 +0200 Subject: [PATCH] Document how to generate theme previews locally --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index 65b9b9cbe..31e043cef 100644 --- a/README.rst +++ b/README.rst @@ -51,3 +51,19 @@ 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