diff --git a/README.md b/README.md index bee1cdf..f74410c 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,76 @@ # Prosopopee -More or less a small clone of exposure.co or Medium in form of a static generator. For -those of you who don't know what exposure.co is, this allows you to tell a -story with your pictures. - Prosopopee. Static site generator for your story. +Make beautiful customizable pictures galleries that tell a story using a static website generator written in Python. You don't need care about css, code and presentation, manage your contents in YAML file and Prosopopee will take care about the rest. + +Prosopopee is sections oriented, make it very flexible, many kinds of section already available: + +* Parallax +* Group of pics (gallery) +* Paragraph +* Iframe (Youtube, Maps, etc..) +* Quote +* [And more](http://prosopopee.readthedocs.io/en/latest/sections.html) + +## Screenshots + ## Features - * Thumbnails & multiple resolutions for fast previews (JPEG progressive). - * Videos support. - * Mobile friendly. - * Multi level gallery. - * Support themes. - * Password access. - * Image lazy loading. - * Night Mode. - * Hackable. +Prosopopee currently supports: + + * Lightweight + * Thumbnails & multiple resolutions for fast previews (JPEG progressive) + * Videos support + * Mobile friendly + * Caching for fast rendering + * Multi level gallery + * Support themes (default, material, light) + * Password access (encrypt page) + * Image lazy loading + * Night Mode + * Completely static output is easy to host anywhere + * Hackable -## TODO + ## Examples - * More sections +You can find example usages here: + +* http://surleschemins.fr +* http://media.faimaison.net/photos/galerie/ +* https://www.thebrownianmovement.org/ +* http://outside.browny.pink +* http://such.life +* http://www.street-art.me + ## Code example + +```yaml +title: Title +date: 2015-12-18 +cover: P1070043-01-01.jpeg +sections: + - type: full-picture + image: P1060979-01-01.jpeg + fixed: true + text: + title: My Story + sub_title: some subtitle + date: 2015-12-18 + - type: paragraph + title: Beautiful Title + text: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor + - type: pictures-group + images: + - + - P1060938-01-01.jpeg + - P1060946-01-01.jpeg + - P1060947-01-01.jpeg + - P1060948-01-01.jpeg +``` ## Usage -``` +```bash prosopopee prosopopee preview prosopopee deploy @@ -45,17 +91,6 @@ GLPv3 http://prosopopee.readthedocs.org/en/latest/ -## Examples - -You can find example usages here: - -* http://surleschemins.fr -* http://media.faimaison.net/photos/galerie/ -* https://www.thebrownianmovement.org/ -* http://outside.browny.pink -* http://such.life -* http://www.street-art.me - ## IRC channel : irc.freenode.net#prosopopee