md2hd

Guide3 min read

Configure the map

Name the map, set its direction, label card types, choose colors, and define relationship pairs.

One frontmatter block with type: map configures the whole map. It does not become a card.

---
type: map
title: Partnerships
layout: LR
inverse:
  works_at: employs
  reports_to: manages
symmetric: [knows]
types:
  organization: { label: Organization, color: '#4A9BFF' }
  person: { label: Person, color: '#3FC8D4' }
  program: { label: Program, color: '#4FBE8B' }
---

Every field is optional.

Configuration fields

FieldWhat it controls
titleMap name.
layoutLR for left to right. Any other value draws top to bottom.
typesDisplay label and color for each card type.
inverseTwo labels for the same directed relationship.
symmetricRelationship labels with no direction.

Other keys in the map block are ignored.

Types and colors

Each type can use a full object or a color shorthand:

types:
  organization: { label: Organization, color: '#4A9BFF' }
  person: '#3FC8D4'

Types you do not list receive colors from the built-in palette in the order they first appear. A custom palette is optional. Use one when the same type should keep the same color across several maps.

Cards that are linked but not defined use reserved gray styling.

Layout direction

Use layout: LR for a wide map. Omit it for top-to-bottom layout.

The toolbar can lay the current map left to right or top to bottom. That action clears saved card positions and lays the map out again. It does not change the Markdown layout: field.

Keep one map block

Use one map block across all imported files. If md2hd finds several, the last one read replaces the earlier configuration rather than merging with it.

The map block may share a file with card blocks.

Saved positions

Dragging a card saves its position with the map, not in the markdown. Hosted maps sync those positions across devices. Your source text stays unchanged.