Giter VIP home page Giter VIP logo

jekylljournal's Introduction

Jekyll Journal

A super awesome way of writing daily blog posts with Jekyll.

It’s like ‘git commit` but for real life.

<img src=“https://badge.fury.io/rb/jekylljournal.svg” alt=“Gem Version” /> <img src=“https://codeclimate.com/github/lorentrogers/jekylljournal/badges/gpa.svg” /> <img src=“https://codeclimate.com/github/lorentrogers/jekylljournal/badges/coverage.svg” /> <img src=“https://gemnasium.com/lorentrogers/jekylljournal.svg” alt=“Dependency Status” /> <img src=“https://img.shields.io/gem/dt/jekylljournal.svg” alt=“Gem Downloads” />

It’s based on this proof of concept, built with bash: github.com/lorentrogers/Journal.sh

Installation

First, you’ll need to grab the gem:

gem install jekylljournal

Then, configure your installation. Make a new file in your home directory called ‘.jekylljournal.yaml` and fill in the options below.

:blog_location: /path/to/your/jekyll/blog/root

Custom Alias

It’s super handy to map an alias to this app. My configuration just uses ‘j` to open up my daily journal.

Here’s what’s in my ‘.zshrc` file:

alias j="jekylljournal"

Usage

Once you’ve installed it, and set up your config file, you’re ready to go:

j

Boom.

You should have Vim open to today’s post.

Once you’ve finished, save the file and close it. Then you can save the journal to git:

j s

Or preview it if you like:

j p

Now you can browse to

localhost:4000

and check out your post.

Contributing

Contributions are very welcome. Have a look at ‘CONTRIBUTING.md` for details.

Gem on Rubygems: rubygems.org/gems/jekylljournal

Bug tracking on Github: github.com/lorentrogers/jekylljournal/issues

Source on Github: github.com/lorentrogers/jekylljournal

Features are written as Job Stories: robots.thoughtbot.com/converting-to-jobs-stories

This project uses GPL: gnu.org/licenses/gpl.html

:include:jekylljournal.rdoc

jekylljournal's People

Stargazers

 avatar

Watchers

 avatar  avatar

jekylljournal's Issues

Support multiple blogs

When I specify a blog, I want it to run any commands relative to that blog, so that I can support multiple installations.

Interactive configuration

When I need to update my config, I want to run an interactive prompt that updates my file for me, so that I don't need to do it manually.

Open posts from the past

When I give the argument 'open <days/months/years> ago', I want it to open the corresponding historical post or offer to create it, so that I can update old content.

Create a default config file if none exists

When I run the application and it can't find the config file, I want to have one generated for me, so that I can quickly get working without having to manually create the file.

Create jekyll project if none exists

When I run the application and there's no existing Jekyll project, I want it to offer to generate one for me, so that I don't have to set it up manually.

Date format from config file

When I create my config file, I want to specify a date format for my posts, so that the app supports multiple countries.

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.