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

Project​Notes

by budlime ST4 New

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

Labels project, notes, todo

Details

Installs

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

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