loading...
The Agile Monkeys

Using VS Code for notes taking

kalm004 profile image Abraham Romero Updated on ・2 min read

Everybody writes notes. I found that my way of doing it was not efficient enough for some reason. I wanted to have them distributed in different folders (logical divisions) and have them synchronized to the cloud in an easy way plus being able to use a decent editor so I decided to give it a try with the one I had already installed: Visual Studio Code.

First of all, I installed the following extensions for VS Code:

Notes extension provides some cool options to ease the notes writing (TODO items and code fragments are key for me)

To accomplish my goal of synchronization to the cloud, I decided to use GitHub as the storage for my notes.

I created a folder for my notes and started a git repository there:

    git init

Then I created a GitHub repo and added it as a remote to the repository:

    git remote add origin git@git.....

I created a script to automate the synchronization with GitHub, I stored it under the notes folder in the path ".auto/commit.sh":

    git add -A
    git commit -m 'auto commit'
    git push origin

As the last step, I configured RunOnSave extension by creating a configuration file in the notes folder under the path ".vscode/settings.json" with this content:

    "emeraldwalk.runonsave": {
        "commands": [
             {
                "match": ".notes",
                "isAsync": true,
                "cmd": "./.auto/commit.sh"
             }
        ]
    }

With the project configured in this way, once a "*.notes" file is saved, it gets automatically committed to the GitHub repository.

With this approach, I found a way to freely organize my notes in the folders I want and synchronize them in a frictionless way.

Posted on by:

kalm004 profile

Abraham Romero

@kalm004

I've been a developer even before I became one, currently working for The Agile Monkeys, the best company I could ever have imagined.

The Agile Monkeys

We create serverless technology

Discussion

pic
Editor guide
 

I'd be interested to hear your thoughts/feedback on GistPad. I built it to provide an in-editor developer library, that can include scratch notes, code snippets, frequently used command line utilities, developer docs, etc. It also supports creating interactive code playgrounds and tutorials, including a CodePen-like preview.

It stores all files as GitHub Gists, and therefore, all of your data is still yours to keep. Additionally, you can discuss your code/notes with others via inline commenting, you can upload images by simply pasting them, group your notes via a flexible tagging system, organize your notes into directories, follow your friends to see what they're up to, and quite a bit more.

I'm super keen to hear any and all feedback, and so it would be awesome to hear if this seems even remotely useful to the workflow you're looking to build 👍

 

So, something I was looking for that led me to your VSCode Extension, is the inline commenting. However what I'd really want would be a way to have that sort of inline comment but right in the repo code. That way we could keep our "no comment" policy in place, but for VSCode users there would still be a way for code authors to leave notes & thoughts & descriptions of functions/classes/components and have other team members able to see the comments and better understand that code (if they so chose).

Is something like that even doable? I'm sorry if this isn't really direct feedback on your extension.

 

I'm not sure if this is exactly what you had in mind, but I just released a new extension this morning (called Code Tour), that allows you to record and playback interactive walkthroughs of a codebase. Might be interesting for your use case?

 

Actually do you know any good resources on writing your own VSCode extension? I'd like to dabble in it and this sounds like a fun problem to try and solve!

 

I'll definitely take a look at it!

 

Hi, does anyone use or heard of Notion? It's the best of it's kind in the store, you would love.

 

Sure, I've heard about it and I have some colleagues using it. I've tried different platforms and this approach seems to be working fine for me by now. Thanks for pointing it out, maybe I give it a try in the future.

 

I’ve been using vscode-journal for a few years and it’s been great!

marketplace.visualstudio.com/items...

 

Wow! That one looks great, I'll take a look at it, thanks!

 

Nice to know, I'm have my way, im have a file called notes.md in my OneDrive directory, and my primary organization is using session notations from markdown, but I will try your tip ty.

 

This is amazing, thank you for sharing. I made my script add a random quote as the commit message XD

dev-to-uploads.s3.amazonaws.com/i/...

 

That's really nice! Thanks for sharing!

 

Hi, so how doas it looks? can you post a screenshot?