Skip to content

Commit

Permalink
Markdown fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
gidlov authored Sep 6, 2017
1 parent e9fe4eb commit b7a231d
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ A Gallery plugin for the micro CMS Pico
=====================
You may find more info on [gidlov.com/code/gallery](http://gidlov.com/code/gallery)

##About##
## About

You can have as many galleries you want, with customizable markup. You can view all on the same page or different pages, and you can choose where on the page. Not so sophisticated, but it gets the job done.

##Example
## Example
[Running example](http://gidlov.com/gallery)

###Setup###
### Setup
As we make use of the excellent [Image](http://intervention.olivervogel.net/) class we have to update the `require` key of `composer.json` and add the following:

"intervention/image": "dev-master"
Expand All @@ -28,11 +28,11 @@ Copy your photos to the fullsize-folder.
Add a `gallery` array to your `config` variable and modify according to your needs.

$config['gallery'] = array(
'my_gallery' => array( // Add %my_gallery% some place in your page.
'page' => 'index', // The page you want to view the gallery.
'image_path' => 'gallery/fullsize', // Original Images.
'my_gallery' => array( // Add %my_gallery% some place in your page.
'page' => 'index', // The page you want to view the gallery.
'image_path' => 'gallery/fullsize', // Original Images.
'thumb_path' => 'gallery/thumbnails', // Must be a empty separate folder.
'flush' => '47b71a856274ac45', // A unique string to delete and regenerate thumbnails.
'flush' => '47b71a856274ac45', // A unique string to delete and regenerate thumbnails.

// These are possible, but not mandatory...
'thumb_size' => array(200, 200),
Expand All @@ -46,10 +46,10 @@ Add a `gallery` array to your `config` variable and modify according to your nee
'after_image' => '',
'image_class' => '',
'alt_image' => '',
'exclude' => array(), // Exclude file name(s).
'sort_by' => '', // Sort by empty or 'random'.
'order_by' => '', // Order by ampty or 'reverse'.
),
'exclude' => array(), // Exclude file name(s).
'sort_by' => '', // Sort by empty or 'random'.
'order_by' => '', // Order by ampty or 'reverse'.
));

Save your `config.php` and enter the URL `http://example.com/index/my_gallery/flush/47b71a856274ac45` to generate the thumbnails.

Expand All @@ -59,14 +59,13 @@ Add `%my_gallery%` to your `index.md` file, or wherever you want.

Visit http://example.com/index to see your new gallery.

####Done!####
#### Done!

##Requirements##
## Requirements

- PHP 5.3

##License##
## License

Gallery is released under [LGPL](http://www.gnu.org/licenses/lgpl-3.0-standalone.html).

[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/1cfa2054cba60fb1326e6c9c1cfb44bd "githalytics.com")](http://githalytics.com/gidlov/pico-gallery)

0 comments on commit b7a231d

Please sign in to comment.