Skip to content

Support multiple injection regions / diagrams per markdown file #90

Description

@FabianClemenz

Context

Deferred from the --inject design (markdown injection, v0.10.0). The initial implementation supports one marker region per target file (the README 95% case):

<!-- erdify:start -->
```mermaid
erDiagram
  ...

## Idea (future)

Allow several independent regions in one file — e.g. a per-schema or per-source diagram in different sections of the same doc. Likely needs **named** markers so each `erdify --inject` call targets a specific region:

```markdown
<!-- erdify:start id=auth -->   ... <!-- erdify:end id=auth -->
<!-- erdify:start id=billing --> ... <!-- erdify:end id=billing -->

Why deferred (YAGNI)

The common need is a single ERD in the README. Multi-region adds marker-naming syntax, ambiguity rules, and CLI surface (which region + which scope per region) that aren't justified until someone asks. Tracking here so the single-region marker format stays forward-compatible (i.e. don't paint ourselves into a corner — leave room to add an id= attribute later).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    deferredParked by design; revisit when a real need shows upenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions