https://github.com/Ziqi-Yang/typst-mode.el

Emacs support for Typst.
https://github.com/Ziqi-Yang/typst-mode.el

emacs emacs-mode typst

Last synced: about 2 months ago
JSON representation

Emacs support for Typst.

• Host: GitHub
• URL: https://github.com/Ziqi-Yang/typst-mode.el
• Owner: Ziqi-Yang
• License: gpl-3.0
• Archived: true
• Created: 2023-03-23T13:31:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-25T00:40:20.000Z (about 1 year ago)
• Last Synced: 2024-04-04T19:38:18.904Z (6 months ago)
• Topics: emacs, emacs-mode, typst
• Language: Emacs Lisp
• Homepage: https://sr.ht/~meow_king/typst-mode/
• Size: 140 KB
• Stars: 59
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-typst-cn - typst-mode.el - based typesetting system (编辑器集成插件 / Emacs)

README

        
# Typst Mode

**Note**: For Emacs 29 users, please use [typst-ts-mode](https://git.sr.ht/~meow_king/typst-ts-mode) instead, which is a lot more consummate than this mode.  

**Note2**: I suppose I have no motion and plan to update this major mode in a long time, so I'll achieve 

this major mode(github). I will spend more energy into maintaining `typst-ts-mode` and [uben0/tree-sitter-typst](https://github.com/uben0/tree-sitter-typst)  

**Note3**: If someone wants to renew `typst-mode` and built it on top of the existing code, contact me (`[email protected]`), I can transfer this repo to you.

Emacs support for [Typst](https://github.com/typst/typst). 

## Requirements

1. `typst`

## Installation

With `use-package` and `straight`:

``` emacs-lisp

(use-package typst-mode

  :straight (:type git :host github :repo "Ziqi-Yang/typst-mode.el"))

```

Manually:

``` emacs-lisp

;; add typst-mode directory to the load-path

(push (expand-file-name "modules/languages/typst-mode" user-emacs-directory) load-path)

;; load tyspt-mode

(require 'typst-mode)

```

## Provided Functions

1. `typst-compile` (default keybinding: `C-c C-c`; also provide `typst-compile-preview`)

2. `typst-preview` (default keybinding: `C-c C-p`)

3. `typst-toggle-watch` (default keybind: `C-c C-w`; also provide `typst-watch` and `typst-stop-watch`)

## Customization

Faces can be configured through `M-x customize`: `Text` -> `Typst` -> `Typst Mode Faces`.

## Contribution

This project is mainly hosted on [SourceHut](https://sr.ht/~meow_king/typst-mode/), which means you are welcome to use email as the primary contribution methods (including proposing an new idea on public mailing list and send a patch via `git send-email`). However, it is also acceptable to use GitHub.   

[Mailing lists](https://sr.ht/~meow_king/typst-mode/lists)