Skip to content

Notes Directory Layout

Jump to bottom
riomoo edited this page Apr 8, 2026 · 1 revision

Notes Directory Layout

All notes are stored in ~/.config/nt as plain Markdown files. The directory is a git repository managed automatically by nt.

Structure

~/.config/nt/
├── .git/               ← git repo (auto-managed, do not edit manually)
├── meeting.md
├── ideas.md
├── shopping.md
└── projects/
    ├── roadmap.md
    └── alpha/
        └── sprint.md

Subdirectories

Subdirectories are fully supported. Use a /-separated path anywhere a note name is expected:

nt new  projects/roadmap
nt edit projects/roadmap
nt show projects/roadmap
nt add  projects/roadmap task "Define MVP scope"

Missing parent directories are created automatically. There is no limit to nesting depth (up to 3 levels are searched by nt list).

File Naming

  • Notes are stored with a .md extension.
  • You never need to type the .md suffix — nt adds it automatically.
  • Note names may contain letters, numbers, hyphens, underscores, and forward slashes (for subdirectory paths).

Accessing Notes Directly

Because notes are plain .md files you can:

  • Open them in any text editor
  • Read them with cat, less, or any pager
  • Render them with any Markdown viewer (VS Code, Typora, etc.)
  • Push them to GitHub / Forgejo and browse with web Markdown rendering

Any external edits are picked up by nt on the next run. Run nt git add -A && nt git commit -m "external edits" if you want to commit changes made outside of nt.

Changing the Notes Directory

The notes directory is currently hard-coded to ~/.config/nt. If you need a custom path, edit the relevant constant in your edition:

  • Bash: NT_DIR variable near the top of nt.sh
  • Go: the path string in NewApp() inside app.go

Clone this wiki locally