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

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