Skip to content

ame-neko/todo-notes

Repository files navigation

Todo Notes

Manage todo and take notes in markdown.

Features

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

  • Links to image are automatically updated to the relative link from destination notes directory.

  • Metadata can be added to each todo task. Metadata is converted to yaml front matter in the destination note.

    • You can add any metadata in following syntax:
      [metadata]: # (YOUR_METADATA_KEY_VALUE_IN_YAML_FORMAT)
    • Special metadata:
      • [metadata]: # (Tags: []): Tags of notes. Notes are categorized by tags in tree view.
      • [metadata]: # (Title: ): Title of note markdown. The title will be inserted on the first line of the note. Default is the text of checkbox.
      • [metadata]: # (FileName: ): File name of note where todo contents will be copied.
      • [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 for details of append mode.

  • Tree view is generated based on the tags of each notes.
    Tags need to be specified in yaml front matter of each note files.
    For example:

    ---
    Tags: [TAG_A, TAG_B]
    ---
    YOUR NOTES CONTENTS
    
  • You can generate a virtual document that contains the contents of all notes for a given tag.

Keybindings

  • ctrl+k (cmd+k): Add new checkbox with template.
  • ctrl+d (cmd+d): Set checkbox checked and copy todo contents to new note file.
  • ctrl+alt+j (cmd+alt+j): Set checkbox checked.
  • ctrl+e (cmd+e): Set checkbox checked and delete contents of todo.

Extension Settings

This extension contributes the following settings:

Settings name Description Default
todoNotes.saveNotesPath Path to directory where notes will be saved. notes
todoNotes.dateFormat Date format used in metaata. yyyy-mm-dd'T'HH:MM:sso
todoNotes.addCompletionDate Add completion date to the yaml front matter of copied notes. True
todoNotes.appendMode Change the behavior when a file already exists at the time of saving a file.
- Append: Add todo contents to the end of file
- Overwrite: Overwrite the file with the contents of todo
- Increment: Change the file name by adding the number to the end of file name
Overwrite
todoNotes.showDialogueWhenFileExist Check if note file already exist or not before copying todo contents. If true and the file exists, a confirmation dialog will be displayed. Effective only when append mode is "Overwrite". True
todoNotes.todoRangeDetectionMode Toggle todo range detection mode. strict: Detect todo range strictly following GFM markdwon syntax. next-todo: Todo range continues until next same or higher indent level todo. strict
todoNotes.eol End of Line character of created note. Operating System Default
todoNotew.colorizeTagIcon Colorize tag icon in tags tree view. The color is automatically determined from the hashcode of tag name. True
todoNotes.inheritParentTodoMetadata Inherit the metadatas such as tags and folderPath from parent todo Task. True

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published