README updates

pull/46/head
Romain Prieto 8 years ago
parent c61681253f
commit 5553ab0c9b

@ -12,8 +12,8 @@
Build static HTML galleries from local photos & videos.
- thumbnails & multiple resolutions for fast previews
- mobile friendly website with customisable themes
- only rebuilds changed files: it's fast!
- supports custom styles
- uses relative paths so you can deploy the pages anywhere
- works great with Amazon S3 for static hosting
@ -104,8 +104,9 @@ $ thumbsup [args]
```
`thumbsup` keeps track of which files need updating.
Re-running the command above when nothing has changed will show the same
output but only take a second, even on a gallery of thousands of photos and videos.
Re-running the command above when nothing has changed will show the same output but only take a second,
even on a 50GB folder with thousands of photos and videos.
## Configuration
@ -200,9 +201,11 @@ You can also use [s3cmd](http://s3tools.org/) which offer a few more options.
## Password protection
Amazon S3 buckets do not offer any type of authentication. However you can choose to deploy to another web server that offers password protection, such as HTTP Basic Auth.
Amazon S3 buckets do not offer any type of authentication. If you want to protect your galleries, you can
An alternative is to deploy the galleries to UUID-based locations, like Dropbox shared galleries.
- deploy the galleries to UUID-based locations, like Dropbox shared galleries
- use [CloudFront with signed cookies](http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in front of S3
- deploy to another web server that offers password protection, such as Varnish/Apache/Nginx with `HTTP Basic Auth`
## Dev notes

@ -1,26 +1,35 @@
TODO: explain themes
# Themes
Most themes can be configured/tweaked using LESS variables in your `-css` styles.
e.g.
Here are the themes available for Thumbsup.
Please submit a pull-request to submit new themes.
Themes can be configured/tweaked by overriding [LESS](http://lesscss.org/) variables,
using the `--css` option.
```bash
thumbsup --css custom.less
thumbsup --theme default --css custom.less
```
```less
@myvar: #cef9b6;
@flag: false;
@text-color: #cef9b6;
```
# Default
## Default
![default theme](docs/screenshot-default.jpg)
![default theme](screenshot.jpg)
Config variables
Configuration variables
| Variable | Description |
|-------------|-------------|
| @accent | Main theme color: title, some borders... |
| @background | Background color of the navigation and albums |
| @borders | Border of all navigation and albums |
| @body-background | Page background color |
| @header-background | Header background color |
| @header-foreground | Header title color |
| @nav-background | Sidebar navigation background color |
| @nav-highlight | Sidebar hover effect color |
| @album-background | Album cover background color |
| @text-color | Main text color |
| @text-light | Lighter text color |
| @borders | General border color |
| @mobile-trigger | Width below which is switches to mobile mode |

Loading…
Cancel
Save