https://github.com/sillyfreak/typst-plum

Create UML class diagrams in Typst; inspired by but *not* compatible with PlantUML
https://github.com/sillyfreak/typst-plum

typst typst-package

Last synced: over 1 year ago
JSON representation

Create UML class diagrams in Typst; inspired by but *not* compatible with PlantUML

• Host: GitHub
• URL: https://github.com/sillyfreak/typst-plum
• Owner: SillyFreak
• License: mit
• Created: 2024-10-31T11:08:49.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-21T20:40:28.000Z (over 1 year ago)
• Last Synced: 2025-02-24T02:15:59.529Z (over 1 year ago)
• Topics: typst, typst-package
• Language: Rust
• Homepage: https://typst.app/universe/package/plum
• Size: 3.65 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Plum

_Plum_ lets you create UML class diagrams in Typst; inspired by but _not_ compatible with PlantUML.

## Getting Started

To add this package to your project, use this:

````typ

#import "@preview/plum:0.0.1"

#let diagram = ```

#[pos(0, 1)]

class Foo as X {

  - attr

  attr2

}

#[pos(1, 0)]

interface Bar {

  + attr

}

#[pos(2, 1)]

abstract class Baz {

  # bars

}

#[bend(45deg)]

X ..|> Bar

#[via((1, 0.4), (2, 0.4))]

Bar <--x-o Baz

```

#plum.plum(diagram)

````

![Example](./thumbnail.png)

## Usage

See the [manual](docs/manual.pdf) for details.