https://github.com/OrangeX4/vscode-typst-sync

A vscode extension for Typst local packages management and synchronization.
https://github.com/OrangeX4/vscode-typst-sync

synchronization typst vscode-extension

Last synced: 3 months ago
JSON representation

A vscode extension for Typst local packages management and synchronization.

• Host: GitHub
• URL: https://github.com/OrangeX4/vscode-typst-sync
• Owner: OrangeX4
• License: mit
• Created: 2023-10-10T07:28:42.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-30T06:09:36.000Z (about 1 year ago)
• Last Synced: 2024-10-04T16:25:56.782Z (4 months ago)
• Topics: synchronization, typst, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=OrangeX4.vscode-typst-sync
• Size: 112 KB
• Stars: 12
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-typst - Typst Sync - A vscode extension for Typst local packages management and synchronization. (Integrations & Tools / Editor Integrations)

README

        
![](./icon.png)

# Typst Sync

A tool for Typst local packages management and synchronization.

https://github.com/OrangeX4/vscode-typst-sync

## Features

- `Shift + Cmd/Ctrl + P` to open the command panel to execute the commands. Of course, you can also set shortcuts for these commands.

- **Typst Package Manage**: manage your typst local packages.

  - `Import Typst Package` command: get text like `#import "@preview/example:0.1.0": *` and search local packages and preview packages.

  - `Import Typst Local Package` command: get text like `#import "@local/mytemplate:0.1.0": *` and only search local packages.

  - `Create Typst Local Package` command: create a typst local package.

  - `Open Typst Local Package` command: open a typst local package entrypoint file to edit it.

- **Sync**: synchronize local packages to remote repository.

  - You MUST to configure `syncRepo` setting to enable sync feature. **You can input a empty repo in github to init it.**

  - `Typst Sync`: synchronize local packages with remote repository.

  - `Push Typst Repo`: push to repository (actually consistent with `Typst Sync`).

  - `Pull Typst Repo`: pull from repository only.

## Requirements

**You should have git installed locally for simple-git to work.**

## Extension Settings

This extension contributes the following settings:

- `vscode-typst-sync.syncRepo`: syncRepo like https://github.com/OrangeX4/typst-sync-repo.git

- `vscode-typst-sync.dataDir`: data-dir in https://github.com/typst/packages#local-packages

## Release Notes

### 0.2.0

- add command `Import Typst Package`

- add command `Import Typst Local Package`

- add command `Create Typst Local Package`

- add command `Open Typst Local Package`

- add command `Push Typst Repo`

- add command `Pull Typst Repo`

- add command `Typst Sync`

## License

This project is licensed under the MIT License.