mirror of
https://github.com/tomasvarg/gallerymaker.git
synced 2026-03-01 08:28:48 +00:00
43 lines
1.4 KiB
Markdown
43 lines
1.4 KiB
Markdown
# Gallery Maker for Node
|
|
|
|
A static html gallery maker based on Node.
|
|
|
|
## Usage
|
|
|
|
```
|
|
Usage: gallerymaker <command> <source dir> [<dest dir>]
|
|
|
|
<dest dir> will be sanitized <source dir> + ".web" suffix if not provided.
|
|
|
|
Commands:
|
|
prepare Prepares gallery file structure based on the <source dir>
|
|
with sanitized names and resized images (see config.json for
|
|
conversion settings) in <dest dir>;
|
|
creates contents.json with original to sanitized names map
|
|
as a source for image captions.
|
|
list Prepares gallery contents list html (list.html).
|
|
gallery Prepares gallery contents html (gallery.html).
|
|
all Runs all the commands (with proper chaning - prepare first).
|
|
```
|
|
|
|
## Image Processing
|
|
|
|
Image resizing done by [sharp](http://sharp.dimens.io/) ([github](https://github.com/lovell/sharp)).
|
|
|
|
## TODO
|
|
|
|
- ~~image processing test~~
|
|
- ~~read images from a dir~~
|
|
- ~~resize the images~~
|
|
- ~~save them with sanitized names~~
|
|
- create html frontend for image list
|
|
- ~~list the images~~
|
|
- provide thumbnails
|
|
- provide <img/> tag literals for copy-pasting
|
|
- create the gallery
|
|
- site index page creation (from a template) with gallery integration
|
|
- use some lightbox on the prepared directory
|
|
- further development
|
|
- integration with other projects (iframe? ajax? web component? Polymer?)
|
|
- config.json support (for specifying conversion settings)
|