/vscode-memo

Markdown knowledge base with bidirectional [[link]]s built on top of VSCode

Primary LanguageTypeScriptMIT LicenseMIT

Memo

Markdown knowledge base with bidirectional [[link]]s built on top of VSCode.

Inspired by Obsidian.md and RoamResearch.

codecov PRs Welcome

Why?

Because your knowledge base deserves to be powered by open source. Read more here.

Getting started

If you want to try out Memo just install it via marketplace using this link and open the help folder in VSCode.

Known issues

Image preview on hover is currently not compatible with VSCode 1.53 and 1.54. Possible fix is investigated, so use it at your discretion.

To enjoy all features, you can use VSCode 1.52 (November 2020), which can be downloaded from this page.

Features

  • 🔗 Links support

    • Creating links

      • Creating links
    • Links navigation

      • Links navigation
    • Embedding notes and images

      • Embedding notes and images
    • Automatic links synchronization on file rename

      • Automatic links synchronization
    • Links rename via Rename Symbol command

      • Links rename via command
    • Links labeling

      • Links labeling
    • Support for short and full links on filename clash

      • Support short and full links on filename clash
    • Opening links with unsupported file formats in the system default app

      • Links labeling
    • Find all references

      • Find all references
  • 🖼️ Notes and images preview (built-in & on-hover)

Notes and images preview

  • 🦋 Creating notes on the fly

Creating notes on the fly

  • 🖇 Backlinks panel

Backlinks panel

  • 🕹 Commands

    • "Open link" command support for links following

    • "Open link to the side" command allows you to open link in the adjacent/new column of the editor

    • "Open daily note" command which creates a note with a title in yyyy-mm-dd format or opens already existing one

      • Open daily note command
    • "Open random note" command which allows you to explore your knowledge base a little bit

      • Open random note command
    • "Open link in the default app" command for opening unsupported file formats in the system default app

    • "Rename Symbol" command support for renaming links right in the editor

FAQ

Contributing

Changelog

See changelog here.