Skip to content
/ notd Public

Lightweight notes for your repo. Leave a thought, not a document.

Notifications You must be signed in to change notification settings

niccoates/notd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

notd

Lightweight notes for your repo. Leave a thought, not a document.

notd stores notes as Markdown files in a .notd/ folder at the root of your repo. Notes are committed to git alongside your code — no external services, no databases, just files.

Installation

npm install -g notd-cli

Usage

notd new        # create a new note
notd list       # list all notes
notd edit [id]  # edit a note's tags
notd delete [id] # delete a note

If you omit the [id], you'll be shown a list to pick from.

Note format

Notes are stored in .notd/ as Markdown files named after their first line:

.notd/
└── fix-the-auth-bug.md

Each file includes frontmatter with timestamps and tags:

---
created: 2025-02-24T10:30:00.000Z
updated: 2025-02-24T10:30:00.000Z
tags:
  - auth
  - api
---

Fix the auth bug

The token expiry check is using the wrong timezone. Need to normalise
to UTC before comparing. See the discussion in PR #42.

Requirements

Node.js v18 or later.

About

Lightweight notes for your repo. Leave a thought, not a document.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •