graph-gen

KO | EN

gitlite — search

#python #ai #typescript #llm #golang #machine-learning #deep-learning #linux #windows #awesome #cli #kubernetes #vue #pytorch

(★ 17)

Graph view for your Typst notes with preview syncing

graph-gen Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# graph-gen

Graph view for your typst notes

![alt text](https://raw.githubusercontent.com/euwbah/graph-gen/main/0.1.0/imgs/graph-example.png)

## Quick start

1. Import the package and use the show rule in your typst document:
    ```
    #import "@preview/graph-gen:0.1.0": *

#show: graph-gen-rules
    ```
    You may also use this repository directly as a [local typst package](https://github.com/typst/packages?tab=readme-ov-file#local-packages).

2. Clone this repository (path to repo will be referred to below as `path/to/graph-gen`).

3. (Highly recommended) set up a virtual environment:
    ```sh
    cd path/to/graph-gen
    python -m venv .venv
    .venv/Scripts/activate
    ```

or with `uv`:
    ```sh
    cd path/to/graph-gen
    uv venv .venv
    .venv/Scripts/activate
    ```

4. Install dependencies:
    ```sh
    pip install .
    ```

with `uv`:
    ```sh
    uv sync
    ```

5. Open typst preview for your document (for preview sync feature).
6. Run the graph viewer. Use `-h` to see all options.
    ```sh
    python graph-gen.py path/to/document.typ
    ```

If you want to only scroll the preview and not the `.typ` source, use the `-s` or `--no-src-point` flag:
    ```sh
    python graph-gen.py path/to/document.typ -s
    ```
7. Double-click any node to scroll to its location in typst preview.

8. The python script caches graphs in `graph-gen/`. The cache should be manually deleted after updating this typst package.

## Example

See [0.1.0/example.typ](0.1.0/example.typ) for how to add support for theorem-type content (definitions, theorems, etc...) and tutorial questions.

Generate the graph for the example with:
```py
python graph-gen.py 0.1.0/example.typ
```

graph-gen

graph-gen Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

graph-gen

graph-gen Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README