Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Simple and pleasant note taking for SublimeText
Python JavaScript
branch: master
Failed to load latest commit information.
Color Schemes attribute list WIP
Documentation adding install message and some refactoring
Tests removing debugging print statements
lib ST2 compatibility
messages adding install message and some refactoring
.gitignore ST2 compatibility
Default (Linux).sublime-keymap added settings for jotter and documentation
Default (OSX).sublime-keymap bring back shift+tab is OS X
Default (Windows).sublime-keymap added settings for jotter and documentation
Default.sublime-commands added new features:
Main.sublime-menu - Fix menu mnemonic. Gets rid of the console nag
Note-fenced.tmLanguage fixing note-fenced, adding code to clean up brain
Note.sublime-settings removed a bunch of settings that should not be imposed by plugin
Note.tmLanguage BUG: two header after one another is incorrect in symbol list
Notes Index.hidden-tmLanguage Note Buffer WIP
Notes Index.sublime-settings first github push
Notes.sublime-settings Fix for default jotter_[date|time]_format settings for Windows compat…
README.md update README
Symbol List - Heading1.tmPreferences BUG: two header after one another is incorrect in symbol list
Symbol List - Heading2.tmPreferences BUG: two header after one another is incorrect in symbol list
Symbol List - Heading3.tmPreferences BUG: two header after one another is incorrect in symbol list
Symbol List - Heading4.tmPreferences BUG: two header after one another is incorrect in symbol list
Symbol List - Heading5.tmPreferences BUG: two header after one another is incorrect in symbol list
Symbol List - Heading6.tmPreferences BUG: two header after one another is incorrect in symbol list
Symbol List - Hide Fenced Code Blocks.tmPreferences added notes setting
jotter.py - Fix menu mnemonic. Gets rid of the console nag
note_headings.py ST2 compatibility
note_todo.py WIP added heading and todo functionalities
notes.py add support for per project root folder
notes_index.py ST2 compatibility

README.md

PlainNotes

Simple and pleasant authoring and note taking for SublimeText.

With PlainNotes you can:

  • Organize notes and thoughts
  • Maintain todo-lists
  • Write documents
  • and probably more

PlainNotes stores and organizes all your notes in a folder and make them accessible with a single shortcut or mouse click. It also provides you with an enhanced version of Markdown markup and some good looking color schemes for note taking. It's been designed with these ground rules in mind:

  • Plain text is the holy grail
  • Plain text shouldn't be that plain
  • Simple and Sexy is Sublime

Usage

Note: Although PlainNotes works under SublimeText 2, some features might not be available. We're not actively testing it under SublimeText 2 but will do our best to make it compatible and usable. We appreciate bug reports and pull requests.

Most of PlainNotes commands are accessible from the SublimeText main menu. You should have a menu item called Notes right after Help. Although, there are faster and easier ways of running those commnads that are mentioned below.

Starting a new note (super+F4)

  • Command palette: Open command palette and search for Notes: new command (typing nn will probably find it for you).
    • To save note in a subfolder of the root directory use /: "subfolder name"/"note name".
  • Shortcut: By default pressing super+F4 will create a new note. For customizing the shortcut see Keyboard Shortcuts section.

Opening an existing note (F4)

  • Command palette: Open command palette and search for Notes: List… command (typing nl will probably find it for you), the command will show the Latest Notes quick panel from which you can select or search for your file.
    The Latest Notes quick panel is sorting files based on their last-edit time, so the note that you have been working on recently should be on top of the list.
  • Shortcut: By default pressing F4 will open the Latest Notes quick panel. For customizing the shortcut see Keyboard Shortcuts section.

Jotter (F1)

Jotter will let you jot down your thoughts and ideas quickly without disturbing your work-flow. It opens a Note Panel at the bottom of the editor which is ready to take your note. When you press ESC it automatically closes the panel and saves your note with a time stamp in your Inbox.

It can be accessed by pressing F1 (that can be customized in your Key-bindings if it conflicts with your other key-bindings) or through Notes: Jotter in command palette. The default color scheme of the jotter panel can be customized in user settings (Preferences -> Package Settings -> PlainNotes -> Settings - User):

{ "jotter_color_scheme": "Packages/PlainNotes/Color Schemes/Sticky-Yellow.tmTheme" }

Inbox

Inbox is where all your quick notes from Jotter live. You can view inbox through Notes: Inbox in command palette or via the Notes main menu. The date and time format of the note headers in inbox can be customized in user settings (Preferences -> Package Settings -> PlainNotes -> Settings - User):

{
    "jotter_date_format": "%d %b %Y",
    "jotter_time_format": "%I:%M %p"
}

Notes Index Card (ctrl+F4)

Pressing ctrl+F4 or selecting Notes: Index from the command palette will give you the Notes Index Card with the list of all notes sorted alphabetically.
Pressing Enter on any note will open it in a new tab.

Change note color

Open command palette and search for Note: Change Color…. it will give you a list of 10 different colors that is shown in the above image. Pressing up and down will give you a preview.
Color of the note is remembered by PlainNotes and whenever you open that file, PlainNotes will set the color-scheme automatically.

Archive note

Open command palette and search for Note: Archive. This will move the note into an archive folder than can be specified in the settings -- The default archive directory is .archive. Archiving a note hides it from the Index and List.

Unarchive notes

Open command palette and search for Note: Unarchive.... This will open a list of archived notes sorted by modification date. Selecting one from the list will unarchive that note.

Delete note

Open a note and then open command palette and search for Note: Delete.

Rename note

Open a note and then open command palette and search for Note: Rename.

Change note file extension

You can change the note file extension in settings. To do so, go to Preferences -> Package Settings -> PlainNotes -> Settings - User and modify "note_save_extension":. The default note type is .note which has the possibility of setting different note colors and some special markup. Alternatively you can use any note extension you want such as markdown .md.

Add yaml front matter to notes

Go to Preferences -> Package Settings -> PlainNotes -> Settings - User and modify "enable_yaml"

By default, the following yaml items are added:

title:
date:
tags:

To add more yaml items you can add them to the settings by modifying note_yaml::

{ "note_yaml" : ["categories"] }

Per-project notes

To have a different notes directory for a project, add the following in your .sublime-project file:

"settings":
    {
        "PlainNotes": 
        {
            "root": "path/to/notes/dir"
        }
    }

License

Copyright 2014-2015 Allen Bargi. Licensed under the MIT License

Something went wrong with that request. Please try again.