Git Product home page Git Product logo

cetz's Introduction

CeTZ

CeTZ (CeTZ, ein Typst Zeichenpaket) is a library for drawing with Typst with an API inspired by TikZ and Processing.

Examples

Karl's Picture Tree Layout 3D Chart
Pie Chart Plot Clustered Barchart

Click on the example image to jump to the code.

Usage

For information, see the manual (stable).

To use this package, simply add the following code to your document:

#import "@preview/cetz:0.1.2"

#cetz.canvas({
  import cetz.draw: *
  // Your drawing code goes here
})

Installing

To install the CeTZ package under your local typst package dir you can use the install script from the repository.

just install

The installed version can be imported by prefixing the package name with @local.

#import "@local/cetz:0.1.2"

#cetz.canvas({
  import cetz.draw: *
  // Your drawing code goes here
})

Just

This project uses just, a handy command runner.

You can run all commands without having just installed, just have a look into the justfile. To install just on your system, use your systems package manager. On Windows, Cargo (cargo install just), Chocolatey (choco install just) and some other sources can be used. You need to run it from a sh compatible shell on Windows (e.g git-bash).

Testing

This package comes with some unit tests under the tests directory. To run all tests you can run the just test target.

You need to have ImageMagick installed on your system, which is needed for image comparison.

Windows

If you are using the Chocolatey package manager, you can install imagemagick using choco install imagemagick. Otherwise download and install a matching package from the ImageMagick website.

Projects using CeTZ

  • circuitypst A port of circuitikz to Typst.
  • conchord Package for writing lyrics with chords that generates fretboard diagrams using CeTZ.
  • finite Finite is a Typst package for rendering finite automata

cetz's People

Contributors

fenjalien avatar flavio20002 avatar jeffa5 avatar johannes-wolf avatar kianmeng avatar lecarrera-tec avatar multisamplednight avatar rubixdev avatar samuzora avatar simonrask avatar wuvist avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.