Khongchai / markdown-todo-vscode

Simple tool to enhance your markdown lists

Markdown-todo

This extension adds a simple deadline functionality to markdown lists. Simply add a date in the format dd/mm/yyyy before any markdown list to see the days remaining until that date (also warn when the deadline approaches).

If the deadline is approaching, you get a squiggly line under the date. The remaining days are always appended to the end of the dates' line.

Adding a Deadline Section

<!-- "Today" is 08/01/2023 -->
22/07/2023
- [ ] Turn in math homework
- [ ] Learn German
27/07/2023
- [ ] Turn in English homework
- [ ] Learn French

Everything under a deadline is grouped as one. To begin a new deadline, simply add another date before the next list.

Result:

Combining With Existing Markdown Syntaxes

<!-- "Today" is 28/07/2023 -->
## 23/07/2023
This extension non-invasively extends markdown syntax, so you can add whatever you want **anywhere you want**. For example, this paragraph could have been an explanation of the two todo lists below. 
- [ ] Study for math test
- [x] ~~_Study for French test_~~
- [x] ~~_Practice violin_~~
## 25/07/2023
- [ ] [Watch this video](https://example.com)
## 27/07/2023 <!-- A date will not be underlined if it does not contain any lists. -->

Result (left vscode, right rendered markdown)

The diagnostics was made to work in vscode. It just parses the markdown file and gives you diagnostics using vscode's LSP API. If you preview it (as seen on the right), you won't see all the deadline diagnostics and reports. But because the dates syntax are basically just markdown, if you render it you'll still see the dates, just not the reported diagnostics.

Ending a Section Early

Due to the nature of the syntax, once you add a date, the parser will try to match any lists below it as a part of the deadline. Doesn't matter if it's already a new topic and you're writing about something else 300+ lines below the date.

To explicitly end a date section, you can add <!-- end section --> comment anywhere below the last list in the section to end it.

<!-- "Today" is 23/07/2023 -->
# **Math Stuff**
## 31/12/2023
- [x] Task1
- [x] Task2
## 01/07/2023
- [ ] Task3
<!-- end section -->
# English Stuff_ 
- [ ] Task1
- [ ] Task2

Result

Codeblocks

If you a date is found to be inside a codeblock, it is ignored.

``` 23/07/2023

• Task1
• Task2 ```

Skipping a Section

If you want to skip a section for whatever reasons -- maybe you got lazy and wanted to just not do the thing, but want don't want to delete the list -- you can add a <!-- skip --> comment anywhere before a section to opt it out of the deadline diagnostics.

22/07/2023
- [ ] Prep task
<!-- skip -->
<!-- got lazy -->
23/07/2023
- [ ] Task1
- [ ] Task2

Moving a Section

This is a bit different from skipping. This is a bit better. Instead of not doing it at all, you are procrastinating.

Add <!-- moved 20/03/2023 --> before the section you want to move. The parser will take not of that section and will complain if the date you moved to does not exist.

This works across all markdown files.

Moving must be done with the exact syntax. The two examples below show the top section moving its items to the bottom, while the bottom move its items with an incorrect syntax (nothing happens).

All Items Moved

Some Items Moved

Full Example (2 files)