VSNotes installs statistics

VS NOTES

VS Notes is a simple tool that takes care of the creation and management of plain text notes and harnesses the power of VS Code via the Command Palette.

<!-- TOC -->

• VS NOTES
• Demo Video
• Repository
• Features
• Quick Start
• Taking Notes
  • Note Filename
    • Filename Tokens
    • File Path Detection
    • Default Template
    • Custom Templates
    • Tags
    • Custom Activity Bar Section & Explorer View
    • Commit and Push
• Settings
• Tips and tricks
• Roadmap & Features
• Change log
• Contributing
• Contributors
• Reviews

<!-- /TOC -->

Demo Video

Click to watch 1 min demo video.

Repository

VS Notes is MIT Licensed and available on Github

Features

1. Access commands quickly from the VS Code command palette Ctrl/Cmd + Shift + p.
2. Set a base folder for your notes and all notes created will be saved in that folder.
3. Easily access latest notes with Open Note command.
4. Retrieve notes via tags in YAML encoded frontmatter on your notes.
5. Open your note folder in a new window.
6. View your notes and tags in your filebar.
7. Automatically insert a VS Code snippet upon creation of a new note.
8. Commit and push to your upstream repository with a single command.
9. New Create a note in a currently open workspace.

Quick Start

• Install the extension from the VS Code Extension menu or click install on this page..
• Open the command palette Ctrl/Cmd + Shift + p and type vsnotes. Select Run Setup.
• Click start and then select a directory to save your notes to.

To modify other settings, open the VS Code settings Preferences > Settings or hit Ctrl/Cmd + , and type in vsnotes in the search bar. To override the setting, copy it over to your user settings file and modify.

• Access VSNotes commands in the command pallette by pressing ctrl/cmd + shift + p and typing vsnotes.

Taking Notes

VSNotes is just a quick way to create files in a single location and retrieve them later. Harness the power of VSCode and the extension ecosystem to customize your note taking workflow. The default file type is markdown and features are built around taking markdown notes. However if you want to save your notes as other types of plain text files, you can change the settings to append a different file extension.

[New in 0.6.0] Create a note in one of the currently open workspaces with the new Create note in workspace command. If you have multiple workspaces open, you will be down a dropdown list to pick which workspace to create a note in.

Note Filename

When creating a new note, VS Notes will look at the vsnotes.defaultNoteTitle setting to grab the format for the file name. This string contains several tokens that is converted by VS Notes when a note is created. Tokens can be modified in the vsnotes.tokens setting, but shouldn't be modified unless necessary. When asked to input a title for your new note, VSNotes can detect file paths and will create subfolders as necessary.

Filename Tokens

Tokens are added to the defaultNoteTitle setting and will automatically insert desired data into the file name of the note. This gives us the ability to specify a simple title for a note and have additional metadata added to the file name.

• datetime: Inserts the current date time in a format specified by the format key. Formatting options. Don't modify type or token keys unless you know what you're doing.

  {
      "type": "datetime",
      "token": "{dt}",
      "format": "YYYY-MM-DD_HH-mm",
      "description": "Insert current datetime"
  }
  

• title: When you create a new note, VS Notes will ask you for a title for the note. After entering a title, it will replace this token with the input text. There shouldn't be any need to modify this setting.

  {
      "type": "title",
      "token": "{title}",
      "description": "Insert note title",
      "format": "Untitled"
  },
  

• extension: The file extension for the file. Defaults to markdown but you can change it to whatever you want. For example, if you prefer plain text notes, change it to .txt.

  {
      "type": "extension",
      "token": "{ext}",
      "description": "Insert file extension",
      "format": "md"
  }
  

Additional Note Titles

[New in 0.7.1] Added a new option vsnotes.additionalNoteTitles which is an array that contains note title tokens. If there are any tokens in this array, a picker will be shown with the option to choose which note title format you'd like to use.

File Path Detection

VSNotes understands file paths and will create folders as necessary. When prompted for a note title, inputting a path will nest the new note under the folders designated in the path. All paths are generated from the main notes folder.

Input text delimited by your system's file path separator. Windows: \ Mac/Linux: /

VSCode generates necessary subfolders and places the new note inside

Default Template…