Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Cubxity/typstudio

A W.I.P desktop application for a new typesetting language, typst.
https://github.com/Cubxity/typstudio

desktop gui hacktoberfest latex rust svelte tailwindcss tauri typescript typesetting typst

Last synced: 6 days ago
JSON representation

A W.I.P desktop application for a new typesetting language, typst.

Awesome Lists containing this project

README

        

# [WIP] typstudio

A W.I.P desktop application for a new markup-based typesetting language, [typst](https://github.com/typst/typst).
Typstudio is built using [Tauri](https://tauri.app/).

![](.github/assets/screenshot.png)

## Features

- [x] Syntax highlighting
- [x] Compiler error markers
- [x] Real time preview
- [ ] Navigate to source
- [x] More performance optimization
- [x] Build/export
- [ ] Complete file explorer system
- [x] Auto complete
- [x] Image pasting
- [ ] Linting and formatting
- [ ] Bibliography assistant
- [ ] Formatting assistant
- [ ] Project creation assistant / templates

...and more to come!

## Installing & Running

Typstudio does not have a stable release yet.

### Development Builds

Development builds are provided in [releases](https://github.com/Cubxity/typstudio/releases).
The builds support Linux (amd64), macOS (amd64, aarch64), and Windows (amd64).

### Packages

**Unstable:**

- AUR (maintained by [alerque](https://github.com/alerque)):
`typstudio` ([link](https://aur.archlinux.org/packages/typstudio))

### Note about running on macOS

When running Typstudio for the first time on macOS, you may see a warning saying that the "Developer can not be
verified". This is only a one-time warning for new files downloaded from the internet that aren't notarized.

To be able to work around it, perform the following steps:

- Right-click on the application, and then click "Open"
- Then, you'll see *yet another* warning from Gatekeeper, just click "Open" again to launch Typstudio

## Development

Do note that development (debug) builds are slower than release builds. Pull requests are welcome!

### Prerequisites

- [pnpm](https://pnpm.io/) and [Node.js](https://nodejs.org/en)
- [Rust toolchain](https://www.rust-lang.org/tools/install)
- [Tauri prerequisites](https://tauri.app/v1/guides/getting-started/prerequisites)

### Getting Started

```bash
pnpm install
pnpm tauri dev # or cargo-tauri dev
```

### Building (Release)

```bash
pnpm tauri build # or cargo-tauri build
```

### Learn more

- [Tauri](https://tauri.app/v1/guides/)
- [Rust](https://doc.rust-lang.org/book/)
- [SvelteKit](https://kit.svelte.dev/docs/introduction) and [Svelte](https://svelte.dev/docs)
- [Tailwind CSS](https://tailwindcss.com/docs)
- [TypeScript](https://www.typescriptlang.org/docs/)

## License

Typstudio is licensed under [GPLv3](COPYING).