Lightweight journal and simple notes support for Visual Studio Code
Switch branches/tags
Nothing to show
Clone or download
Latest commit c5f2446 Sep 23, 2018

README.md

vscode-journal README

Lightweight Extension for Visual Studio Code to take track of your daily notes.

What's this about?

This extension is only useful for people like me, who use simple text files for notes, task lists, and everything else which has to be remembered and searched for. Textfiles are easy to backup, sync and can be opened anywhere by everything. This extension has the following functions:

Features

Press Ctrl+Shift+J to open the journal's smart input and start typing right away. Press F1 or Ctrl+Shift+P to access one of the commands. All supported commands are described (here).

The notes are stored in a folder on your pc using the following structure (taking ZIM Desktop wiki as inspiration: year/month/day.md, the notes files for October 22th would be ../2016/10/22.md. Detailed notes (e.g. meeting notes) are placed in the subfolder ../2016/10/22/some-meeting-notes.md. (soon: will be configurable)

Settings

Settings are described in detail here

You have to set the base folder for notes folder structure before you start. Open your settings, search for 'journal' and copy the journal.base line into your personal settings. Adjust the value, for example: "journal.base": "C:/Users/FooBar/Documents/Journal" (use forward slash!)

The default file format is Markdown (using md as extension), which is natively supported by Visual Studio Code. I use Asciidoc for my notes (with .adoc as extension), in this case you should also install an Asciidoc Syntax extension.

Syntax highlighting is configured in your workspace settings. The options are stored automatically in the settings, you can then manually change them. Make sure to restart to apply the changes. The settings try to recognize if a dark or light theme is used. If you switch in between, you either have to delete the settings (to reload them from the extension) or adapt them for yourself.

Demo

Screen Capture

The demo shows also the use of the vscode-journal-view extension for browsing for vscode-journal by Gruntfuggly