Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Windows PowerShell:
- If the directory or file does not exist, it is created automatically.
- Entries are appended as `[YYYY-MM-DD HH:MM] <text>`.
- `jot` and `jot init` behave the same.
- `jot list` prints the entire file to stdout.
- `jot list` prints the journal and any template notes in the current directory.
- `jot patterns` prints a fixed line.

## Design constraints (do not violate)
Expand All @@ -64,7 +64,7 @@ Windows PowerShell:

- `ensureJournal()` handles path resolution and lazy creation.
- `jotInit()` reads a single line and appends it with a timestamp.
- `jotList()` streams the journal to stdout.
- `jotList()` streams the journal and template notes to stdout.

## Tests

Expand Down
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ You’ll see a simple timeline:
This is not a feed.
It’s a mirror.

Template notes created in the current directory (like meeting, standup, or RFC notes) are included in the list output too.

---

## patterns
Expand Down Expand Up @@ -200,6 +202,53 @@ If it feels quiet, you’re close.

---

## templates

Create structured notes quickly with templates.

```bash
jot new --template daily
```

Add a name to create multiple notes from the same template in a day:

```bash
jot new --template meeting -n "Team Sync-Up"
```

Built-in templates:

```bash
jot templates
# or
jot list templates
```

Templates render a few variables:

* `{{date}}` → `YYYY-MM-DD`
* `{{time}}` → `HH:MM`
* `{{datetime}}` → `YYYY-MM-DD HH:MM`
* `{{repo}}` → current git repo name (empty if not in a repo)

### custom templates

Create a file in your config templates directory and use its filename (without extension) as the template name.

```
~/.config/jot/templates/standup.md
```

On Windows, this lives under `%AppData%\\jot\\templates`. If the config dir is not available, jot falls back to `~/.jot/templates`.

Then run:

```bash
jot new --template standup
```

---

## data & privacy

Your thoughts are yours.
Expand Down
Loading