Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/monferrand/mzettel

A vscode extension to make Zettelkasten notes
https://github.com/monferrand/mzettel

Last synced: about 2 months ago
JSON representation

A vscode extension to make Zettelkasten notes

Awesome Lists containing this project

README

        

# mzettel README

mzettel (Markdown zettelkasten) is an extension to facilitate the creation of
your own [zettelkasten](https://writingcooperative.com/zettelkasten-how-one-german-scholar-was-so-freakishly-productive-997e4e0ca125)
using customizable markdown files.

> There is a sister repo and extension but this one is the regularly maintained.

## Usage

Create a new note using the command palette (CMD/CTRL + Shift + P).
```
CMD + Shift + P -> mzettel note
```

It will prompt you to enter the title of the note and will build and open a
preformatted note in the current workspace.


Toggle Marp preview

```
CMD + Shift + P -> mzettel note link to clipboard
```
Prepare a markdown link for the current note and put it to the clipboard.

### Keyboard Shortcuts

- Use `alt + z` to create a new note.
- Use `alt + l` to send the current note link to the clipboard.

### Configurations

- `mzettel.notesPath`: Give the path were to put the zettelkasten notes. If not set will put the note in the current folder.
- `mzettel.notesTemplate`: The template to use for the notes. You can use ${date} and ${title} parameters.
- `mzettel.filenameTemplate`: The template to use for the note file name. You can use ${date}, ${time} and ${title} parameters. It's an array of string. A new line is created for each element of the array.
- `mzettel.titleSeparator`: Character(s) used to replace the spaces the in title for the filename.