Markdown Memo



Good blog! I've read a lot of documentaries in my work life and none was really up to date. Some of them had a good structure, which is how I came to arc42. The mistake was always that documentation was written in Word and stored in a different system than SAP ERP.

  1. Markdown Document Title
  2. Markdown Memo Meaning

What happend? Broken link! Moreover, most Word users unfortunately cannot use the strengths of Word at all. Then why not use Markdown right away? Fewer options, but learned faster. It can be written with any simple text editor. You don't even want to talk about the comprehensive integration in GitHub 🙂

  1. Markdown-memo This project is meant to make writing easier and more productive. So you want to write a document. Maybe you'll share it on the web.
  2. Create Memo in R Markdown. Ask Question Asked 2 years, 1 month ago. Active 2 years, 1 month ago. Viewed 535 times 4.

In addition, I believe that in the future it will be necessary to be able to generate more documentation automatically at any time based on the development objects. Only the actual development objects are up to date. In this context I would like to look at projects such as 'ABAP to PlantUML'.

For all German-speaking readers: I once published an article on the topic of documentation on heise Developer: 'Of Pyramids and Documentation'.

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

Inspired by Obsidian.md and RoamResearch.

See full list on markdownguide.org.

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.

Markdown memorial

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

Features

  • 🔗 Links support

    • Creating links

    • Links navigation

    • Embedding notes and images

    • Automatic links synchronization on file rename

    • Links rename via Rename Symbol command

    • Links labeling

    • Support for short and full links on filename clash

    • Opening links with unsupported file formats in the system default app

    • Find all references

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

  • 🦋 Creating notes on the fly
  • 🖇 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 random note' command which allows you to explore your knowledge base a little bit

    • '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

  • How to follow link on cmd+enter or ctrl+enter like in Obsidian?
    • Bind built-in editor.action.openLink command to cmd+enter (see example) or use cmd+click on the link
  • Memo missing some feature? Please consider exploring other Markdown plugins from VS Marketplace first. There are plenty of them.

Markdown Document Title

Contributing

  • File bugs, feature requests in GitHub Issues.
  • Leave a review on Visual Studio Marketplace.
  • Read CONTRIBUTING.md for contributing to the code base.

Markdown Memo Meaning

Changelog

See changelog here.





Comments are closed.