Code Monkey home page Code Monkey logo

meta-kanban's Introduction

Obsidian Meta Kanban

This is a plugin for the note-taking app Obsidian which creates a custom code block syntax to generate a Kanban board which is interconnected with the properties (metadata/frontmatter) of the notes in your vault.

This depends on the Dataview and MetaEdit plugins to achive the functionality of quickly and efficiently reading and updating metadata. Please show them some love for all their hardwork!

Usage

Set your codeblock langauge to meta-kanban โ†’ ```meta-kanban The configuration will accept any valid YAML syntax, as long as they match the types described below

Quick Reference

title: string
id: string
property: string
direction: "horizontal" || "vertical"
from: DataviewSource
where: expression returning a boolean
columns: Array<string>
lane: propertyValue, title

Example

title: My Tasks
id: my-tasks
property: progress
direction: horizontal
from: #task
where: p.progress !== 'abandoned'
columns: progress, difficulty
lane: not started, Not Started
lane: in progress, In Progress
lane: completed, Completed

That will then render your Kanban board with the lanes you described and will automatically pull the notes it needs for each lane based on your configuration. Then you can simply drag and drop cards between columns and it will be moved to that column and it's property will be updated accordingly

Roadmap

These features will not have a set schedule as I can only work on this in my free time.

Alpha

This is the first release which will cover all the necessary features for this plugin to be considered 'functioning'.

  • Custom code block syntax
  • Parse code block to JSON
  • Handle errors with validation/parsing
  • Generate cards automatically in each lane
  • Allow cards to be dragged to different lanes
  • Card metadata updated when dragged to different lane
  • Allow cards to be dropped anywhere in the lane and shift other cards

Beta

This will be the release where 'quality of life' improvements are added. Ideally I can get some feedback about what features others may want to see.

  • Add card button on each lane
  • Add card button can be configured to templates and default folder
  • Custom colors for lanes
  • Custom color for board
  • Text alignment options

Backlog

This is not really a release per say, but rather a list of features that I don't have figured out on when I want to try and implement them

  • Resort lanes when rendered
    • Honestly I don't know if this one is worth it since you can easily just edit the code block to do this

meta-kanban's People

Contributors

unxok avatar

Stargazers

a13ph avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.