Project

nikki

0.01
Repository is archived
No commit activity in last 3 years
No release in over 3 years
A simple one-line-a-day journaling app.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.5
>= 0
>= 0

Runtime

>= 0
 Project Readme

Gem Version Inline docs

nikki

"Record something new learned every day of the year."

Track newly learned things

In Japanese, "nikki" means "daily journal". The idea behind nikki is to record one thing you learned today. If all goes well, you've got a 365 line journal formatted in Markdown and ready to be posted to your blog on January 1st next year. The months are H1's and every day in the month is part of an ordered list. The journal file is saved at ~/.nikki_#{year}.md.

Installation

Add this line to your application's Gemfile:

gem 'nikki'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nikki

Usage

nikki help [COMMAND]  # Describe available commands or one specific command
nikki new ENTRY       # Creates a new entry in the Nikki journal.
nikki open            # Open current year's journal file in Vim.
nikki export YEAR     # Save a MultiMarkdown-formatted version of a Nikki journal.

Examples

New entry

nikki new "Brandon Pittman is a super cool guy."

Contributing

  1. Fork it ( http://github.com/brandonpittman/nikki/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request