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 175
  • Win 74
  • Mac 66
  • Linux 35
May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1 Apr 30 Apr 29 Apr 28 Apr 27 Apr 26 Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7 Apr 6 Apr 5 Apr 4 Apr 3 Apr 2 Apr 1 Mar 31 Mar 30
Windows 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 0
Mac 0 0 0 0 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0
Linux 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 0 0 0 0 0 0 0 0 0 0 0 0 1 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