Skip to content

About

Markdown pursuit trees with navigable Obsidian diagrams

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Pursuits MD 0.1

A Markdown ticket tree with reciprocal links and generated Obsidian diagrams. Each ticket holds its goal, acceptance criteria, status, and notes. A parent file sits beside the ID-named folder that holds its children.

Try the example

From this directory, run the helper with uv. It uses Python 3.11 or newer and PyYAML.

uv run tools/pursuit_graph.py --vault examples/demo-vault check
uv run tools/pursuit_graph.py --vault examples/demo-vault render

Open examples/demo-vault as a vault in Obsidian and start with the example overview. The double-sided node opens the ticket containing the continuation diagram. Diagram links use Obsidian URI support from 1.15.1. Use the overview's Markdown links in other readers.

Use your own vault

  1. Put an overview README.md and your tickets under pursuits/. Set --pursuits-dir for a different vault-relative folder. Set --vault when running outside the vault.

  2. Use the example ticket as a template. Quote IDs in YAML so numeric IDs stay text. Put each child in its parent's ID folder. Write both sides of each relationship as slash-separated wikilinks relative to the vault, with no .md suffix.

  3. Put the following block in the overview. The helper manages Mermaid blocks immediately preceded by this marker.

    <!-- pursuits-md:graph -->
    ```mermaid
    flowchart LR
    ```
  4. Run render to update the diagrams and check to validate the tree and catch stale diagrams. Use render --continuation ID to start a new continuation on a ticket with children. Subsequent runs recognize its marked block.

The helper checks filenames, IDs, parent and child links, folder placement, cycles, status, executor, and completion consistency. It updates diagrams. Edit ticket content, properties, and file placement directly in your vault.

See the proposal, design, requirements, and implementation tasks for the broader design.

About

Markdown pursuit trees with navigable Obsidian diagrams

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages