diff options
author | Justin Mayer <entroP@gmail.com> | 2024-07-28 18:27:30 +0200 |
---|---|---|
committer | Justin Mayer <entroP@gmail.com> | 2024-07-28 18:27:30 +0200 |
commit | 74fb998e1df2fdb914d83e6fbc448152b8081e9b (patch) | |
tree | 261c1988f5a22ddd9651d8c95ba8f17e4c2f90e1 /README.rst | |
parent | cb986aa432759233dee963c1430ab502ac57dbec (diff) | |
download | pelican-themes-74fb998e1df2fdb914d83e6fbc448152b8081e9b.tar.gz |
Document how to generate theme previews locally
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -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 |