Skip to content

Latest commit

 

History

History
52 lines (42 loc) · 1.79 KB

README.md

File metadata and controls

52 lines (42 loc) · 1.79 KB

Privately Public

Build Status Code Climate

A generator that creates privately public pages. Pages secured by url obscurity.

Why?

The use case for having privately public posts is when you have a page drafted but aren't ready to publicly publish it yet. You are ready to share it with close friends to have them proof your horrible grammar though. It publishes your post with a secret url you can share. Security through obscurity!

Usage

Copy the _plugins/privately_public.rb file into your jekyll/octopress projects plugin folder. Now in your posts YAML front-matter add the key privpub: true.

---
layout: post
title: "My Awesome Post"
privpub: true
---

You will now see output in the console when generating your site and you can grab the link from there:

[2013-09-04 21:51:25] regeneration: 1 files changed
PrivatleyPublic: Generated privately public links:
- /private/4d58d7/my-awesome-post

You can now copy the relative path to access the privately public page and share it with friends!

Custom Path

I want to use a custom path instead of /private/ in the url! All you have to do is define privpub_path: /my/custom/dir in your _config.yml. Then you will end up with output like below:

[2013-09-04 21:51:25] regeneration: 1 files changed
PrivatleyPublic: Generated privately public links:
- /my/custom/dir/4d58d7/my-awesome-post

Octopress

Octopress runs on an older version of jekyll so checkout the octopress-v2 branch for a plugin with backwards compatability with older versions of jekyll.