https://github.com/skhg/markdown-diary

📚 Python tool to generate monthly diary files in simple Markdown text file format
https://github.com/skhg/markdown-diary

cli diary journal markdown python text-files

Last synced: 5 months ago
JSON representation

📚 Python tool to generate monthly diary files in simple Markdown text file format

• Host: GitHub
• URL: https://github.com/skhg/markdown-diary
• Owner: skhg
• License: mit
• Created: 2019-01-02T01:32:14.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-12-24T16:56:35.000Z (over 5 years ago)
• Last Synced: 2025-09-15T15:16:04.709Z (9 months ago)
• Topics: cli, diary, journal, markdown, python, text-files
• Language: Python
• Homepage:
• Size: 113 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# markdown-diary

![](https://github.com/skhg/markdown-diary/workflows/.github/workflows/branch-builds.yml/badge.svg?branch=master) ![PyPI](https://img.shields.io/pypi/v/markdown-diary) ![PyPI - Downloads](https://img.shields.io/pypi/dm/markdown-diary)

Diary file template generator, producing text files in [Markdown](https://en.wikipedia.org/wiki/Markdown) format.

I use this personally to keep a simple monthly diary of my notes and activities. Since it just produces a series of text files, they can be stored in something like Dropbox, and synced everywhere easily. 

![Screenshot of typical usage](screenshot.png)

## Installation

`pip install markdown-diary`

## How to use

`pip install` adds the command `md-diary` to your `/bin` PATH so you can run it directly from the command line.

Run `md-diary` for help.

### For a single month

Run `md-diary YYYY-mm` (e.g. `md-diary 2019-01`) which will create a file called `01 January.md`

The format looks like:

```

# January

## Week 1

### Tue 1

### Wed 2

### Thu 3

### Fri 4

## Week 2

### Mon 7

### Tue 8

...

```

### For a whole year

Like above, but run `md-diary YYYY` (e.g. `md-diary 2021`) which will create the files `01 January.md`, `02 February.md`, `...` in the current directory. 

### Options

Use the `-w` flag to output weekdays only.

## Dependencies

* Python 2.7 or 3.x