## File: README.md

# Obsidian Kanban Plugin

**The Kanban plugin is looking for new maintainers.** Interested? [Read more here.](https://github.com/mgmeyers/obsidian-kanban/blob/main/MAINTAINERS.md)

---

Create markdown-backed Kanban boards in [Obsidian](https://obsidian.md/)

- [Bugs, Issues, & Feature Requests](https://github.com/mgmeyers/obsidian-kanban/issues)
- [Development Roadmap](https://github.com/mgmeyers/obsidian-kanban/projects/1)





## Documentation

Find the plugin documentation here: [Obsidian Kanban Plugin Documentation](https://publish.obsidian.md/kanban/)

---

## File: docs/How do I/Add a date to a card.md

Dates can be added to cards in two ways.

When you type the [[Date trigger]], the date selection calendar will display.

![[Screen Shot 2021-09-15 at 9.23.04 PM.png]]

Alternatively, you can right-click on a card, or click on the three dots menu and select `Add a date`, which will also display the date selection calendar.

![[Screen Shot 2021-09-15 at 9.23.46 PM.png]]

---

## File: docs/How do I/Add a time to a card.md

Times can be added to cards in two ways.

When you type the [[Time trigger]], the time selection dropdown will display.

![[Screen Shot 2021-09-15 at 9.25.31 PM.png]]

Alternatively, cards that already have dates will allow you to add a time using the right click or three dots menu.

![[Screen Shot 2021-09-15 at 9.26.41 PM.png]]

---

## File: docs/How do I/Add an image to a card.md

Images can be added to cards in two ways.

### Embedding images

Images can be embedded into Kanban cards just like you would in any other obsidian note.

![[Screen Shot 2021-09-16 at 9.15.04 AM.png]]

![[Screen Shot 2021-09-16 at 9.15.47 AM.png]]

### Displaying images from metadata

To add an image to a card, first enable a [[Linked page metadata]] key/value, with the key set to the metadata field containing an image. Toggle `Field contains markdown`.

![[Screen Shot How-to-add-metadata-to-card.png]]
  
#### Adding image to frontmatter

If the [[Linked page metadata]] key you're pulling in is in the linked page's frontmatter, **image embeds must be wrapped in quotes, or contain other text before the embed**. This is a quirk of [YAML](https://help.obsidian.md/Advanced+topics/YAML+front+matter). (See also: [[Frontmatter limitations & gotchas]])
  
```yaml

---

delivery-notes: "![[LinkToImage.png]]"

---

```

![[Screen Shot How-to-add-image-to-card.png]]

#### Adding image to inline metadata

Images can also be added to inline metadata if the [Data View](https://github.com/blacksmithgu/obsidian-dataview) plugin is active. When adding an image via inline metadata, quotes are not required.

```markdown
Lorem ipsum dolor sit amet, consectetur adipiscing elit.

delivery-notes:: ![[LinkToImage.png]]

Pellentesque egestas, nibh et pellentesque ullamcorper, lorem mauris pellentesque tellus, a cursus nunc metus at velit.

```

---

## File: docs/How do I/Create a Kanban board.md

To create a new Kanban board, you can:

Right-click on a folder and select `New Kanban board`.

![[Screen Shot 2021-09-15 at 9.14.52 PM.png]]

Execute the command palette command, `Kanban: Create new board`, which will create a board at the root of your vault.

![[Screen Shot 2021-09-15 at 9.15.11 PM.png]]

Or convert an empty file into a Kanban board with the command palette command, `Kanban: Convert empty note to Kanban`.

![[Screen Shot 2021-09-15 at 9.15.31 PM.png]]

---

## File: docs/How do I/Create notes from cards.md

Notes can be created from Kanban cards by right clicking on a card, or clicking on the three dots menu on the right side of a card, and selecting `New note from card`.

![[Screen Shot 2021-09-13 at 12.29.20 PM.png|400]]

This will create a new note in the [[Note folder]] using the [[Note template]] with the card's content as the title. The card will then link to the new note.

![[Screen Shot 2021-09-13 at 12.33.39 PM.png|250]]

---

## File: docs/How do I/Install the plugin.md

The Kanban plugin can be found in [Obsidian's](https://obsidian.md/) community plugins library, `Settings > Community Plugins > Browse`. Once installed, the plugin must also be activated. See here for [[Create a Kanban board|instructions on creating Kanban boards]].

![[Screen Shot 2021-09-16 at 1.02.48 PM.png]]

---

## File: docs/How do I/Search a Kanban board.md

You can search a Kanban board like you would any other file in Obsidian. By default, the hotkey is  `Command` or `CTRL` + `F`.

![[Screen Shot 2021-09-15 at 9.21.37 PM.png]]

---

## File: docs/How do I/Set a WIP Limit.md

To set a WIP (work in progress) limit for a lane, specify it in parentheses after the lane title
when creating or renaming it. For example, to set the limit cards amount in the existing "In Progress"
lane to 5, rename it to `In Progress (5)`.

This limit will be displayed next to the item counter of the lane:

![[Screen Shot WIP-Limit.png]]

Once the number of cards exceeds the limit, the counter text will become bold:

![[Screen Shot WIP-Limit-exceeded.png]]

To update the WIP limit, simply rename the lane specifying the new value.

---

## File: docs/How do I/View a Kanban's archive.md

Currently, a Kanban's archive can only be viewed by viewing the board as markdown.

![[Screen Shot 2021-09-13 at 4.04.40 PM.png]]

At the bottom, you will see the board's archive (if it has one).

![[Screen Shot 2021-09-13 at 4.04.59 PM.png]]

To return to Kanban view, press `Ctrl + p`, search for "Kanban: Toggle between Kanban and markdown mode" and run it with `Enter`.