Planner

A terminal-first planner and journal system.

Write structured .pln files in Vim. Generate a polished HTML dashboard. View locally, on mobile, or through synchronized static files.

---

Screenshots

[screenshot desktop]

[screenshot mobile]

---

Features

• Vim-friendly
• Static HTML output
• Daily templates
• Three-column planning system
• Projects and checklists
• Notes and journaling
• Mobile-friendly dashboard
• No database
• Plain text storage
• tmuxinator template

---

Quick Start

git clone ...

./bin/make_day.sh
./bin/build.sh

---

Data Structure

data/
├── templates/
├── YYYY/
│   ├── MM/
│   │   ├── YYYY-MM-DD.pln

Each day (.pln file) is a plain text file.

---

Creating Days

Days are generated by:

./bin/make_day.sh

Templates are stored in:

data/templates/

The weekday template is selected automatically.

---

Building HTML

./bin/build.sh

Produces an html file in build/dashboard.html

---

The PLN Format

Example .pln

@title Research Day

@project Work color=blue

- [ ] Send email @short
- [x] Finish manuscript @long
- [M] Move task @med

@gap @short

- [?] Optional task @short

@sep @med

@end

Planner Items

Lists

@list Shopping Creates a traditional checklist

Projects (3-column planner blocks)

@project Research color=blue Creates a three-column planner block.

Tasks are assigned to:

@short
@med
@long

Checkbox States

Symbol	Meaning
[ ]	Todo
[x]	Done
[M]	Moved
[?]	Optional
[~]	Cancelled

Layout Helpers

Gap

@gap (@short)

Adds vertical spacing (here with an optional tag restricting it to the "short" column).

Separator

@sep @med

Adds a horizontal divider (here with an optional tag restricting it to the "medium" column").

Vim Integration

The repository contains: .vim/ with:

• ftplugin support
• UltiSnips snippets
• planner commands

as well as a local .vimrc. To enable the project-local vim configuration, add

set exrc
set secure

in your main vimrc.