Skip to content

YukiGasai/obsidian-todo-widget

Repository files navigation

Obsidian Todo Widget

Android Widget to display an interactive todo list from a markdown file

Install

  1. Download the .apk file from the latest release
  2. Install with package manager
  3. Run the main app once
  4. Allow the storage permission to read and write external files

Setup

  1. Select widget from the widget list
  2. Drag to Homescreen
  3. Enter the Obsidian Vault name to use
  4. Configure the file to use
  5. Press "Select" to define the folder where the file(s) is/are stored.
  6. Enter the single filename or enter a date pattern
  7. If you want to limit the the tasks to a specific header enter the header name into the "Header" field
  8. If you want to include sub Headers check the "Include Sub Headers" switch
  9. Press Create

Note:

  • The widget only work for Android Oreo(SDK 26) and up.
  • Make sure the date format inside the curly brackets exists. Here are some options

Example

preview

Filename examples

Static file

  • Quicknote
  • Todos

Daily note

  • {{yyyy-MM-dd}}
  • Daily-{{dd}}-{{MM}}-{{yyyy}}

Demonstration

DEMO.mp4

Disclaimer

Due to limited android / kotlin experience, this project is certainly messy.

About

Android Widget to display todo list from markdown file

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages