Skip to content

List Notes

List Notes allow you to leverage your existing bullet list structure. You can turn a note into a List Note by adding the following to your frontmatter:

---
BC-list-note-field: "<field>"
---

Where <field> is one of your edge fields. For example:

---
BC-list-note-field: "down"
---
- [[A]]
- [[B]]
- [[C]]
- [[D]]

In this example, A goes down to B and D, and Bgoes down to C:

flowchart TB
	1(List Note) -- down --> 2(A) -- down --> 3(B) -- down --> 4(C)
	2 -- down --> 5(D)

By default, each item in the list will use the BC-list-note-field value to add edges. But you can override this on a per-item basis by adding the field before the link.

---
BC-list-note-field: "down"
---
- [[A]]
- child [[B]]

Would give:

flowchart LR
	1(List Note) -- down --> 2(A) -- child --> 3(B)

By default, every list in the note is read. Set BC-list-note-section to a heading’s text to scope the builder to just that section — only list items under that heading become edges.

---
BC-list-note-field: "down"
BC-list-note-section: "Index"
---
## Index
- [[A]]
- [[B]]
## Notes
- [[C]]

Only A and B become children — the list under ## Notes is ignored. The section runs from its heading to the next heading of equal-or-higher level (or the end of the file), so nested sub-headings stay inside it. If no heading matches, no edges are added.

Keep a link in your list without turning it into a child. BC-list-note-exclude is a list of wiki-links to skip — useful for reference / see-also links.

---
BC-list-note-field: "down"
BC-list-note-exclude:
- "[[Glossary]]"
- "[[See also]]"
---
- [[A]]
- [[Glossary]]

A becomes a down child; Glossary stays in the list but gets no edge. Entries must be wiki-links (Breadcrumbs resolves them the same way Obsidian does).

By default, the list note itself links to the top-level list items. You can exclude this behaviour by adding the BC-list-note-exclude-index field to the frontmatter of the list note.

---
BC-list-note-field: "down"
BC-list-note-exclude-index: true
---
flowchart TB
	2(A) -- down --> 3(B) -- down --> 4(C)
	2 -- down --> 5(D)

Normally, only the parent/child relationships are added. But you can also add edges based on the neighbours of each list item. This is useful for adding sibling/next/prev relationships.

---
BC-list-note-neighbour-field: "<field>"
---

Where <field> is one of your edge fields. For example, point down to all child items, and point next to each neighbouring item

---
BC-list-note-field: "down"
BC-list-note-neighbour-field: "next"
---
- [[A]]
- [[B]]
- [[C]]
- [[D]]
flowchart TB
	1(List Note) -- down --> 2(A) -- down --> 3(B) -- down --> 4(C)
	2 -- down --> 5(D)
	3 -- next --> 5
  • Default Neighbour Field: Choose a default field to use for the neighbour relationships. This is useful if you have a lot of list notes, and don’t want to add the BC-list-note-neighbour-field to each one.