https://github.com/fenjalien/cirCeTZ

A port of circuitikz to Typst using CeTZ!
https://github.com/fenjalien/cirCeTZ

typst

Last synced: 6 days ago
JSON representation

A port of circuitikz to Typst using CeTZ!

• Host: GitHub
• URL: https://github.com/fenjalien/cirCeTZ
• Owner: fenjalien
• License: apache-2.0
• Created: 2023-04-20T22:42:31.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-03T22:52:00.000Z (7 months ago)
• Last Synced: 2024-05-21T12:53:44.801Z (6 months ago)
• Topics: typst
• Language: Typst
• Homepage:
• Size: 1.14 MB
• Stars: 108
• Watchers: 4
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-typst - circuitypst - A library for drawing electronic circuit schematics (Templates & Libraries / Engineering)

README

        
# circuitypst

# THERES WORK ON THE DEV BRANCH THIS PROJECT ISN'T DEAD

A port of [`circuitikz`](https://github.com/circuitikz/circuitikz) to Typst using [`typst-canvas`](https://github.com/johannes-wolf/typst-canvas). Due to the size of `circuitikz` features will be ported as I need them for my own work, if theres a feature you need feel free to make an issue, PR or contact me through Typst's discord (same username)!

![](assets/current%20shunt.png)

## "Installation"

Because of Typst's current lack of package management the library expects to be placed in the same folder as `typst-canvas`.

```

typst-canvas/

circuitypst/

```

You can either clone the repository or download it as a `.zip` and extract it to the required location.

## Usage

To get started `node` and `to` should be imported from `circuitypst.typ`, ideally inside `typst-canvas`'s `canvas` function.

Here is a template:

```typ

#import "typst-canvas/canvas.typ": canvas

#canvas(length: 1cm, debug: false, {

  import "typst-canvas/draw.typ": *

  import "circuitypst/circuitypst.typ": node, to

  ...

})

```

Also see `examples/` for some examples. 

## Requirements for First Stable Release

- [ ] Reference manual (doesn't have to inclued tutorials, just a list of currently supported components)

- [ ] Tests

- [ ] CI

- [ ] More components?