Code Monkey home page Code Monkey logo

jekyll-birdlist's Introduction

jekyll-birdlist

Jekyll plugin for bird watchers

This plugin allows you to attach a list of birds to each blog post. These lists will be compiled to provide a lifelist - a list of all the birds ever seen - and a page for each bird with a list of sightings.

Installation

Assuming you have already installed Jekyll:

  1. Place birdlist.rb in your _plugins folder (if you don't) have one, create it in the root folder of your site.
  2. Add birdpage.html to your _layouts folder.
  3. Add the lifelist folder and index.html to the root of your project.
  4. Either replace your post layout (_layouts/post.html) with the one in this repository, or add the code below to your own post.html

Usage

Add the following variables to the YAML front-matter of your blog posts. Examples are provided in the two sample posts in the repository.

birds

This is the list of birds that you wish to record for this post. It can be in a bulleted list or comma separated format.

birds:
  - Carrion crow
  - Jackdaw
  - Magpie
  - Common Buzzard

or

birds: [Carrion crow, Jackdaw, Magpie, Common Buzzard]

location

You can specify a location for each post; this will appear in the list of sightings on each bird page.

location: Mirkwood
  • this is completely optional.
  • it's freeform, you will have to decide for yourself how granular to be.
  • you can only specify one location per post; if your day's birding takes in multiple locations I can only suggest splitting it into multiple posts?
  • in the future I may develop the location idea further, to enable garden, patch, county, state and country lists.

jekyll-birdlist's People

Contributors

bighairydave avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.