Browse files

Create gh-pages branch via GitHub

  • Loading branch information...
1 parent 3d2226e commit 6731186b29ec6cc121c70ec49fb5c14362e19650 @j0k3r committed Feb 24, 2013
Showing with 77 additions and 15 deletions.
  1. +76 −14 index.html
  2. +1 −1 params.json
View
90 index.html
@@ -31,32 +31,94 @@
<hr>
<section id="main_content">
- <h3>Welcome to GitHub Pages.</h3>
+ <h1>jekyll-flickr-photoset</h1>
-<p>This automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new branch:</p>
+<p>It's a Jekyll plugin for embedding Flickr photosets in your Liquid templates.</p>
-<pre><code>$ cd your_repo_root/repo_name
-$ git fetch origin
-$ git checkout gh-pages
+<p>I was moving from Posterous to Jekyll and I was looking for a slideshow gallery like Posteours has. You put a simple tag with a Flickr photoset ID inside your post and it builds a slideshow gallery. So I made it: one tag generate a gallery, no more. Dead simple.</p>
+
+<h2>Usage</h2>
+
+<pre><code>{% flickr_photoset 12345678901234567 %}
+{% flickr_photoset 12345678901234567 "Square" "Medium 640" "Large" %}
+</code></pre>
+
+<p>Where:</p>
+
+<ul>
+<li>
+<code>12345678901234567</code> is the Flickr photoset ID (can be found in this kind of url: <code>http://www.flickr.com/photos/j0k/sets/72157624158475427/</code>)</li>
+<li>
+<code>"Square"</code> is the size for the thumbnail image (*which also the one by default*)</li>
+<li>
+<code>"Medium 640"</code> is the size for the displayed image (*which also the one by default*)</li>
+<li>
+<code>"Large"</code> is the size for the opened image (*which also the one by default*)</li>
+</ul><p>Other Flickr size can be found <a href="http://www.flickr.com/services/api/flickr.photos.getSizes.html">here</a>.</p>
+
+<h2>Requirements</h2>
+
+<h4>FlickRaw</h4>
+
+<p><em>Flickraw is a library to access flickr api in a simple way.</em></p>
+
+<pre><code>gem install flickraw
</code></pre>
-<p>If you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.</p>
+<h4>A Flickr API key</h4>
+
+<p>You can obtain a Flickr API key <a href="http://www.flickr.com/services/apps/create/">here</a>.
+And follow instructions on <a href="http://hanklords.github.com/flickraw/">the FlickRaw page for authentication</a>:</p>
+
+<ul>
+<li>create a <code>flickr.rb</code> file with content of "Authentication" bloc code</li>
+<li>replace api key by the one previously generated on the Flickr website</li>
+<li>launch it with <code>ruby -rubygems flickr.rb</code>
+</li>
+<li>follow instructions</li>
+</ul><p>Then put them inside <code>_config.yml</code> (where <code>flickr:</code> is defined on the root level):</p>
+
+<pre><code>flickr:
+ cache_dir: ./_cache/flickr
+ api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+ shared_secret: xxxxxxxxxxxxxxxx
+ access_token: xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx
+ access_secret: xxxxxxxxxxxxxxxx
+</code></pre>
+
+<p>There is also an ability to generate cache. It will put all images references from each photoset. It will save <strong>a lot of time</strong> when you will have to regenerate all your posts. Cache are written in a yml file. Photoset ID is the file name.</p>
-<h3>Designer Templates</h3>
+<h4><a href="http://adgallery.codeplex.com/">AD Gallery</a></h4>
-<p>We've crafted some handsome templates for you to use. Go ahead and continue to layouts to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved if it remained markdown format.</p>
+<p>This is the plugin used to generate the slideshow gallery, which is almost the same from Posterous. You will find references in <code>adgallery</code> folder, I put the latest version (1.2.7).</p>
-<h3>Rather Drive Stick?</h3>
+<p>So you need to load it:</p>
-<p>If you prefer to not use the automatic generator, push a branch named <code>gh-pages</code> to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator written by our own Tom Preston-Werner. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.</p>
+<pre><code>&lt;link rel="stylesheet" href="/ad-gallery/jquery.ad-gallery.css" /&gt;
+&lt;script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"&gt;&lt;/script&gt;
+&lt;script type="text/javascript" src="/ad-gallery/jquery.ad-gallery.js?rand=302"&gt;&lt;/script&gt;
+&lt;script type="text/javascript"&gt;
+$(function() {
+ var galleries = $('.ad-gallery').adGallery({
+ loader_image: '/ad-gallery/loader.gif',
+ width: 640,
+ });
+})
+&lt;/script&gt;
+</code></pre>
-<h3>Authors and Contributors</h3>
+<h2>Todo</h2>
-<p>You can <a href="https://github.com/blog/821" class="user-mention">@mention</a> a GitHub username to generate a link to their profile. The resulting <code>&lt;a&gt;</code> element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (<a href="https://github.com/defunkt" class="user-mention">@defunkt</a>), PJ Hyett (<a href="https://github.com/pjhyett" class="user-mention">@pjhyett</a>), and Tom Preston-Werner (<a href="https://github.com/mojombo" class="user-mention">@mojombo</a>) founded GitHub.</p>
+<ul>
+<li>handle fullscreen slideshow and use <code>urlOpened</code> image</li>
+</ul><h2>Inspiration</h2>
-<h3>Support or Contact</h3>
+<p>I've looked inside :</p>
-<p>Having trouble with Pages? Check out the documentation at <a href="http://help.github.com/pages">http://help.github.com/pages</a> or contact <a href="mailto:support@github.com">support@github.com</a> and we’ll help you sort it out.</p>
+<ul>
+<li><a href="https://github.com/cnunciato/jekyll-flickr">jekyll-flickr</a></li>
+<li><a href="http://www.marran.com/tech/integrating-flickr-and-jekyll/">Integrating Flickr and Jekyll</a></li>
+</ul>
</section>
<footer>
View
2 params.json
@@ -1 +1 @@
-{"name":"Jekyll-flickr-photoset","tagline":"A Jekyll plugin for embedding Flickr photosets","body":"### Welcome to GitHub Pages.\r\nThis automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new branch:\r\n\r\n```\r\n$ cd your_repo_root/repo_name\r\n$ git fetch origin\r\n$ git checkout gh-pages\r\n```\r\n\r\nIf you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.\r\n\r\n### Designer Templates\r\nWe've crafted some handsome templates for you to use. Go ahead and continue to layouts to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved if it remained markdown format.\r\n\r\n### Rather Drive Stick?\r\nIf you prefer to not use the automatic generator, push a branch named `gh-pages` to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator written by our own Tom Preston-Werner. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.\r\n\r\n### Authors and Contributors\r\nYou can @mention a GitHub username to generate a link to their profile. The resulting `<a>` element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (@defunkt), PJ Hyett (@pjhyett), and Tom Preston-Werner (@mojombo) founded GitHub.\r\n\r\n### Support or Contact\r\nHaving trouble with Pages? Check out the documentation at http://help.github.com/pages or contact support@github.com and we’ll help you sort it out.","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
+{"name":"Jekyll-flickr-photoset","tagline":"A Jekyll plugin for embedding Flickr photosets","body":"# jekyll-flickr-photoset\r\n\r\nIt's a Jekyll plugin for embedding Flickr photosets in your Liquid templates.\r\n\r\nI was moving from Posterous to Jekyll and I was looking for a slideshow gallery like Posteours has. You put a simple tag with a Flickr photoset ID inside your post and it builds a slideshow gallery. So I made it: one tag generate a gallery, no more. Dead simple.\r\n\r\n## Usage\r\n\r\n {% flickr_photoset 12345678901234567 %}\r\n {% flickr_photoset 12345678901234567 \"Square\" \"Medium 640\" \"Large\" %}\r\n\r\nWhere:\r\n\r\n- `12345678901234567` is the Flickr photoset ID (can be found in this kind of url: `http://www.flickr.com/photos/j0k/sets/72157624158475427/`)\r\n- `\"Square\"` is the size for the thumbnail image (*which also the one by default*)\r\n- `\"Medium 640\"` is the size for the displayed image (*which also the one by default*)\r\n- `\"Large\"` is the size for the opened image (*which also the one by default*)\r\n\r\nOther Flickr size can be found [here](http://www.flickr.com/services/api/flickr.photos.getSizes.html).\r\n\r\n## Requirements\r\n\r\n#### FlickRaw\r\n\r\n*Flickraw is a library to access flickr api in a simple way.*\r\n\r\n gem install flickraw\r\n\r\n#### A Flickr API key\r\n\r\nYou can obtain a Flickr API key [here](http://www.flickr.com/services/apps/create/).\r\nAnd follow instructions on [the FlickRaw page for authentication](http://hanklords.github.com/flickraw/):\r\n\r\n - create a `flickr.rb` file with content of \"Authentication\" bloc code\r\n - replace api key by the one previously generated on the Flickr website\r\n - launch it with `ruby -rubygems flickr.rb`\r\n - follow instructions\r\n\r\nThen put them inside `_config.yml` (where `flickr:` is defined on the root level):\r\n\r\n flickr:\r\n cache_dir: ./_cache/flickr\r\n api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\r\n shared_secret: xxxxxxxxxxxxxxxx\r\n access_token: xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx\r\n access_secret: xxxxxxxxxxxxxxxx\r\n\r\nThere is also an ability to generate cache. It will put all images references from each photoset. It will save **a lot of time** when you will have to regenerate all your posts. Cache are written in a yml file. Photoset ID is the file name.\r\n\r\n#### [AD Gallery](http://adgallery.codeplex.com/)\r\nThis is the plugin used to generate the slideshow gallery, which is almost the same from Posterous. You will find references in `adgallery` folder, I put the latest version (1.2.7).\r\n\r\nSo you need to load it:\r\n\r\n <link rel=\"stylesheet\" href=\"/ad-gallery/jquery.ad-gallery.css\" />\r\n <script src=\"//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js\"></script>\r\n <script type=\"text/javascript\" src=\"/ad-gallery/jquery.ad-gallery.js?rand=302\"></script>\r\n <script type=\"text/javascript\">\r\n $(function() {\r\n var galleries = $('.ad-gallery').adGallery({\r\n loader_image: '/ad-gallery/loader.gif',\r\n width: 640,\r\n });\r\n })\r\n </script>\r\n\r\n## Todo\r\n\r\n- handle fullscreen slideshow and use `urlOpened` image\r\n\r\n## Inspiration\r\n\r\nI've looked inside :\r\n\r\n- [jekyll-flickr](https://github.com/cnunciato/jekyll-flickr)\r\n- [Integrating Flickr and Jekyll](http://www.marran.com/tech/integrating-flickr-and-jekyll/)\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}

0 comments on commit 6731186

Please sign in to comment.