Skip to content

Commit

Permalink
update README.md and package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
ame-neko committed Oct 9, 2022
1 parent 1402fd9 commit 277c2bb
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Manage todo and take notes in markdown.

- Move todo contents to notes directory when the todo task is completed.
By using the `Complete Todo and Copy to Notes` command (`ctrl+d` or `cmd+d`), the contents of the checkbox at the cursor's location are copied to the notebook.
![](https://github.com/ame-neko/todo-notes/blob/master/images/complete-todo-explanation.gif)
![](https://github.com/ame-neko/todo-notes/blob/master/images/complete-todo-explanation.gif?raw=true)
- Links to image files are automatically updated.
- Metadata can be added to each todo task. Metadata is converted to yaml front matter in the destination note.

Expand All @@ -19,7 +19,7 @@ Manage todo and take notes in markdown.
- `[metadata]: # (FolderPath: )`: Specify the path from workspace where note file will be created (Default: The value of `todoNotes.saveNotesPath` setting).
- `[metadata]: # (AppendMode: )`: Change append mode (`Append`/`Overwrite`/`Increment`) of this todo contents. See [Extension Settings](#Extension-Settings) for details of append mode.

![](https://github.com/ame-neko/todo-notes/blob/master/images/metadata-explanation.gif)
![](https://github.com/ame-neko/todo-notes/blob/master/images/metadata-explanation.gif?raw=true)

- Tree view is generated based on the tags of each notes.
Tags need to be specified in yaml front matter of each note files.
Expand All @@ -31,7 +31,7 @@ Manage todo and take notes in markdown.
YOUR NOTES CONTENTS
```
- You can generate a virtual document that contains the contents of all notes for a given tag.
![](https://github.com/ame-neko/todo-notes/blob/master/images/tag-tree-explanation.gif)
![](https://github.com/ame-neko/todo-notes/blob/master/images/tag-tree-explanation.gif?raw=true)

## Keybindings

Expand Down
11 changes: 10 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "todo-notes",
"displayName": "Todo Notes",
"description": "",
"version": "0.0.1",
"version": "0.0.2",
"engines": {
"vscode": "^1.71.0"
},
Expand All @@ -15,6 +15,15 @@
"url": "https://github.com/ame-neko/todo-notes.git"
},
"icon": "images/icon.png",
"discriptions": "Copy the contents of the Todo task in Markdown to another file.",
"keywords": [
"notes",
"todo",
"copy",
"tag",
"markdown"
],
"license": "MIT",
"activationEvents": [
"onLanguage:markdown"
],
Expand Down

0 comments on commit 277c2bb

Please sign in to comment.