My personal recommendation is, if you want to use this theme, to use it by cloning or forking and customizing from there. At the bottom of the Readme is a gem installation method. I think this might be more difficult to work with but feel free to give it a try.
Can be installed with RVM. Instructions at: https://rvm.io/rvm/install
First manually install bundler with gem install bundler
Then bundle install to resolve the rest of the gem dependencies listed in the Gemfile
After all the dependencies are met, just run $ jekyll serve to run the app.
It should be available in the browser by typing localhost:4000 into the url bar
To create a new post, add a new file to the _posts directory with a title in the format
YEAR-MONTH-DAY-title.MARKUP
for example 2012-09-12-how-to-write-a-blog.md
There are two major parts to a post: front-matter and content
Front matter is metadata that is required by Jekyll and this theme to compose the blog.
It should be in the format:
---
layout: post - literally the word `post`
title: make a title
date: date from the file name
s3-base: url of the bucket of your photos for example
preview: location of a photo in the bucket at s3-base
previousurl: you can link to the previous article here
nexturl: you can link to the next article here
images:
- type: horizontal
id: 1
- type: vertical
id: 1
- type: pano
id: 1
---
Note that the front matter must start and end with ```. The images asssume an amazon s3 bucket (or similiar, ie other host or cdn) with a specific directory structure. Each Bucket should contain two subdirectories
full - the large photos that get displayed when you click on a photo
thumb - the thumbs that get displayed on the photo wall
also at this level should be an image called cover.jpg which will be the preview image for this album
In both full and thumb there should be three subdirectories:
horizontal
vertical
pano
Inside of these directories should be numbered photos starting at 1 ie 1.jpg. So in the images section
- type: horizontal
id: 1
on the photo wall routes to s3-base/thumb/horizontal/1.jpg
and when you click on that photo, the link will be to s3-base/full/horizontal/1.jpg
All that should be needed to generate the photo wall is in the front matter: a layout type of post, the correct image bucket configuration and the images. You can change the order of the images to change the order they display in and improve the photo wall layout.
Check out the sample post in _posts for a working example of what all of this looks like
One final note here is that becuase this relies on a very specific directory structure for your hosted photos, it's almost necessary to replicate that structure locally before uploading
In the _scripts folder I have included two scripts which help automate prepping the photos.
The first step is to create the directory where you want to hold your photos locally, go there, and run the init_blog_post_structure.sh file. This will create the directories you need.
Next, fill it with photos(landscapes in the horizontal, portraits in vertical, panos in pano) and run the setup_blog_pics.sh script. This will resize and redistribute your photos to the proper directories and make sure they have the proper names.
My goal in the future is to write a node script to automate the upload of this structure to s3 but for now I do that by hand. Please submit a pr if you are interested.
Add this line to your Jekyll site's Gemfile:
gem "andes-photocentric-jekyll-theme"And add this line to your Jekyll site's _config.yml:
theme: andes-photocentric-jekyll-themeAnd then execute:
$ bundle
Or install it yourself as:
$ gem install andes-photocentric-jekyll-theme
TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
Bug reports and pull requests are welcome on GitHub at https://github.com/andrew-max/andes-photocentric-jekyll-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
To set up your environment to develop this theme, run bundle install.
Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.
The theme is available as open source under the terms of the MIT License.