siglican/README.md

siglican

A static gallery generator plugin for Pelican, based on the Sigal Colorbox/Galleria static site generator.

##How To

1. Put the contents of this folder into your Pelican plugins directory. Add 'siglican' to PLUGINS in pelicanconf.py.
2. Create a 'siglican' directory in your base directory, at the same level as 'content'. Drag 'colorbox' or 'galleria' from the 'themes' directory into this folder. Also create an 'images' subdirectory under 'siglican'.

   /site
     /content/*
     /plugins/siglican/*.py
     /siglican
       /images
         /album1
         /album2
         /...
       /[colorbox|galleria]
         /static/*
         /templates/album.html
   

3. Create album and image metadata, as desired.
4. Create theme directory inside of 'siglican'. Use the colorbox or galleria theme as a starting point. Make sure that your Pelican theme's base.html template has a 'head' block defined before </head>.

To Do

1. Update galleria theme to work.
2. Change settings names to something other than SIGAL_*
3. Unit tests.
4. Logging cleanup.
5. Update colorbox/galleria example themes to deal better with nested albums.
6. General code and documentation cleanup.

##Credits

• The bulk of the code is ported from Sigal v0.8.0 by Simon Conseil.
• Pelican integration by Scott Boone (sawall@github).