https://github.com/skytasul/fletchart

A Typst package to automatically create flowcharts.
https://github.com/skytasul/fletchart

diagram flowchart logic package typst

Last synced: 5 days ago
JSON representation

A Typst package to automatically create flowcharts.

• Host: GitHub
• URL: https://github.com/skytasul/fletchart
• Owner: SkytAsul
• Created: 2024-08-23T10:49:08.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-25T14:12:18.000Z (3 months ago)
• Last Synced: 2024-10-12T03:44:31.464Z (about 1 month ago)
• Topics: diagram, flowchart, logic, package, typst
• Language: Typst
• Homepage:
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# fletchart

`fletchart` (contraction of `fletcher` and `flowchart`) is a Typst package made to easily create flowcharts using the `fletcher` package.

## How to use

There are two ways of creating flowcharts with `fletchart`:

1. The "declarative" way, where you create every element and manually setup the links between them. To use it:

    ```typst

    #import "src/lib.typ" as fletchart

    #import fletchart.declarative: fc-declarative

    #import fletchart.elements: *

    #fc-declarative({

        // your elements here

    })

    ```

1. The "logical" way, where you declare a logic structure with custom if-else blocks which will be automatically turned to a flowchart. To use it:

    ```typst

    #import "src/lib.typ" as fletchart

    #import fletchart.logical: fc-logical, fc-if, fc-process, fc-begin, fc-end, fc-io, fc-predefined-process

    #fc-logical({

        // your logic here

    })

    ```

## Examples

You can find examples in the [examples](examples) folder.