Skip to content

Latest commit

 

History

History
74 lines (58 loc) · 3.46 KB

README.md

File metadata and controls

74 lines (58 loc) · 3.46 KB

Release GitHub release (latest SemVer) GitHub All Releases

This is a plugin for Obsidian (https://obsidian.md).

Note:

You will need an api token from Amazing Marvin. You can get one here - https://app.amazingmarvin.com/pre?api

For more information, please read here - https://github.com/amazingmarvin/MarvinAPI/wiki/Marvin-API

Examples

image

Will render

image

Configs

The configs has to be put in a valid JSON formats, the plugin will actually raise errors if it cannot convert (relying on JSON.parse) Example of a valid config:

{
    "title": "Due today",
    "type": "due-today",
    "showNote": true
}

All configs:

Name Description Type Default
title Title of the block. string -
type Type of the block. "today" | "due-today" -
showNote Show notes. Default to true. boolean false
colorTitle Color the name of category, project and tasks. If false, will only color the icons. boolean true
hideEmpty Hide empty directory. Default to true. boolean true
inheritColor Inherit colors from closest parent. Default to true. boolean true
showLabel Whether to render labels or not. Default to true. boolean true
isAnimated Whether to animate transitions boolean true

Config interface

export interface Query {
  title?: string;
  type?: 'today' | 'due-today';
  showNote: boolean;
  colorTitle: boolean;
  hideEmpty: boolean;
  inheritColor: boolean;
  showLabel: boolean;
  isAnimated: boolean;
}

export const DEFAULT_QUERY: Query = {
  colorTitle: true,
  showNote: false,
  hideEmpty: true,
  inheritColor: true,
  showLabel: true,
  isAnimated: true,
};

Support

If you find this plugin valuable, please let me know! It is great to hear from people who use what I've built. If you really like this plugin and want to express that by buying me a coffee, please do!

ko-fi

Please don't ever feel obligated!