# flickr-to-jekyll

> 🖼 Save the Flickr photos in your Jekyll posts

Latest version **1.0.0** (published 2018-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install flickr-to-jekyll
pnpm add flickr-to-jekyll
yarn add flickr-to-jekyll
bun add flickr-to-jekyll
```

Provides the command `flickr-to-jekyll`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-11-03 |
| First published | 2018-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 143.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Katy DeCorah |
| Maintainers | katydecorah |

## Links

- npm: https://www.npmjs.com/package/flickr-to-jekyll
- Repository: https://github.com/katydecorah/flickr-to-jekyll
- Homepage: https://github.com/katydecorah/flickr-to-jekyll#readme
- Issues: https://github.com/katydecorah/flickr-to-jekyll/issues
- npm.io page: https://npm.io/package/flickr-to-jekyll

## Dependencies (3)

- [request](https://npm.io/package/request.md) ^2.88.0
- [d3-queue](https://npm.io/package/d3-queue.md) ^3.0.7
- [flickrapi](https://npm.io/package/flickrapi.md) ^0.6.0

## Recent versions

- 1.0.0 (latest) — 2018-11-03

## README

# flickr-to-jekyll

🖼 Save the Flickr photos in your Jekyll posts

This script will:

1. Scan your `_posts` folder for Flickr hosted images (jpg, png, gif).
2. Retrieve the original size of the photo and download it using the title of the post for a filename.
3. Update the post with the new image path names.

💡 Tip: This project pulls down the original file size for archival purposes. You should resize and/or compress your images (either manually or through a build script) to best manage the weight and load time of your site.

## Set up

Get your Flickr credentials:

- `FLICKR_KEY` - [Create a Flickr app](https://www.flickr.com/services/apps/create/) to get an API key.
- `FLICKR_SECRET` - Your Flickr app's API secret.

Set your environment variables with your credentials (replace the placeholders) and enter this in your terminal:

```
echo "export FLICKR_KEY=your-key-here" >> ~/.bash_profile
echo "export FLICKR_SECRET=your-secret-here" >> ~/.bash_profile
```

From terminal, install the package globally and link it so you can run it from your Jekyll site later:

```
npm install flickr-to-jekyll -g && npm link
```

## Run it

Navigate to your Jekyll site directory in terminal. From terminal, run:

```
flickr-to-jekyll
```

The default for `posts_dir` is `_posts`. The default for `img_dir` is `img/posts`.

To change where you have your posts saved or where you want to save your image:

```
flickr-to-jekyll --posts_dir='notes/_posts --img_dir='notes/img/posts' '
```

---
_Source: https://npm.io/package/flickr-to-jekyll · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._