forks/sigal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
Simon Conseil
2013-05-06 23:33:09 +02:00
parent a72722a5cd
commit 1b9f0ab1b1
2 changed files with 41 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.rst
View File

@@ -1,5 +1,5 @@
sigal - yet another simple static gallery generator Sigal - Simple Static Gallery Generator
=================================================== =======================================
.. image:: https://secure.travis-ci.org/saimn/sigal.png?branch=master .. image:: https://secure.travis-ci.org/saimn/sigal.png?branch=master
:target: https://travis-ci.org/saimn/sigal :target: https://travis-ci.org/saimn/sigal
@@ -8,10 +8,10 @@ sigal - yet another simple static gallery generator
Sigal is yet another simple static gallery generator. It's written in Python Sigal is yet another simple static gallery generator. It's written in Python
and it allows to build a static gallery of images with the following features: and it allows to build a static gallery of images with the following features:
* process directories recursively, * Process directories recursively.
* resize images and create thumbnails, * Generate HTML pages using jinja2 templates.
* generate html pages using jinja2 templates, * Relative links for a portable output.
* relative links for a portable output, * Themes support.
* MIT licensed. * MIT licensed.
Links : Links :

55
docs/index.rst
View File

@@ -1,21 +1,21 @@
======= =======================================
Sigal Sigal - Simple Static Gallery Generator
======= =======================================
Sigal is yet another simple static gallery generator. It's written in Python Sigal is yet another simple static gallery generator. It's written in Python
and it allows to build a static gallery of images with the following features: and it allows to build a static gallery of images with the following features:
* process directories recursively, * Process directories recursively.
* generate HTML pages using jinja2 templates, * Generate HTML pages using jinja2 templates.
* relative links for a portable output, * Relative links for a portable output.
* Themes support.
* MIT licensed. * MIT licensed.
The idea behind Sigal is to ease the use of the javascript librairies like The idea behind Sigal is to ease the use of the javascript librairies like
`galleria`_. These librairies do a great job to display the images, Sigal does `galleria`_. These librairies do a great job to display the images, Sigal does
what is missing: resize images, create thumbnails, generate html pages. what is missing: resize images, create thumbnails, generate html pages.
Sigal is currently compatible only with python 2. It will be ported to python Sigal is currently compatible only with python 2.
3 when PIL/Pillow will be available for python 3.
Links : Links :
@@ -57,7 +57,9 @@ Dependencies
~~~~~~~~~~~~ ~~~~~~~~~~~~
- Argh - Argh
- Clint
- Jinja2 - Jinja2
- Pilkit
- Python Imaging Library (PIL / Pillow) - Python Imaging Library (PIL / Pillow)
- Python Markdown - Python Markdown
@@ -65,20 +67,24 @@ Dependencies
How to Use How to Use
---------- ----------
To get started, just run ``sigal init`` which will copy an example Init
configuration file in the current directory. All configuration values have a To get started, just run ``sigal init`` which will copy an example
default; values that are commented out serve to show the default. Default configuration file in the current directory. All configuration values have a
values are specified when modified in this example config file. default; values that are commented out serve to show the default. Default
values are specified when modified in this example config file.
After adapting the configuration to your needs, put your images in a Build
sub-directory and run ``sigal build <your images directory>``. The next time After adapting the configuration to your needs, put your images in a
you run ``sigal build``, only the new images will be processed. Use the ``-f`` sub-directory and run ``sigal build <your images directory>``. The next time
flag to force the reprocessing of all the images. you run ``sigal build``, only the new images will be processed. Use the
``-f`` flag to force the reprocessing of all the images.
To visualize your gallery, you can use ``sigal serve`` which runs a basic web Serve
server. This server should only be used for local browsing, not in production. To visualize your gallery, you can use ``sigal serve`` which runs a basic
Another option is to use the ``index_in_url = True`` setting, which will add web server. This server should only be used for local browsing, not in
``index.html`` to the urls to allow browsing without a server. production. Another option is to use the ``index_in_url = True`` setting,
which will add ``index.html`` to the urls to allow browsing without a
server.
Help of the ``sigal build`` command Help of the ``sigal build`` command
@@ -153,6 +159,15 @@ the first image of the directory is used as thumbnail.
Changelog Changelog
--------- ---------
Version 0.4.0-dev
~~~~~~~~~~~~~~~~~
Released on 2013-xx-xx.
- Add a setting to disable the writing of HTML files.
- Use Pilkit.
- Remove multiprocessing.
Version 0.3.3 Version 0.3.3
~~~~~~~~~~~~~ ~~~~~~~~~~~~~