ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Project​Notes

by budlime ST4

A simple Sublime Text packages that helps you keep project notes organized

Labels project, notes, todo

Details

Installs

  • Total 218
  • Win 99
  • Mac 76
  • Linux 43
Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19
Windows 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0 0 1 0 0
Mac 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

This package provides two commands:
project_notes_open and project_notes_list


default settings

{
  "notes_dir_path": "...",
  "note_file_name": "todo",
  "add_note_dir_to_project": true,
  "note_dir_name": "notes"
}

project_notes_list

This will display a quickpanel listing the names of projects which have a note named $note_file_name. And open that file upon selection.

project_notes_open

When the command is executed it will open the file:
$notes_dir_path/$PROJECT_NAME/$note_file_name

If there is no project associated with the active window the command will not do anything.

If notes_dir_path is not a path to an existing directory (example: ~/Documents/notes), it will default to: SUBLIME_PACKAGE_PATH/User/notes (~/sublime-text/Packages/User/notes).

If add_note_dir_to_project is set to true the directory containing the note will get added to the current project with the display name defined for note_dir_name.

Why?

I often find myself wanting to keep notes, lists of links and other files related to a project, in its own directory, outside the project, so i don't accidentally commit those files to git.

This simple package makes that workflow seamless.

keybinding

There is no keybindings enabled by default, I personally use Alt+n:
“JSON { "keys”: [“alt+n”], “command”: “project_notes_open” } { “keys”: [“alt+shift+n”], “command”: “project_notes_list” }

## contact

bug/issues/enhancements:  
https://github.com/budlime/ProjectNotes

## license

### 0BSD