Skip to content

Commit

Permalink
Document how to generate theme previews locally
Browse files Browse the repository at this point in the history
  • Loading branch information
justinmayer committed Jul 28, 2024
1 parent cb986aa commit 74fb998
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 74fb998

Please sign in to comment.