Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaarmu/typst.vim
Vim plugin for Typst
https://github.com/kaarmu/typst.vim
Last synced: 26 days ago
JSON representation
Vim plugin for Typst
- Host: GitHub
- URL: https://github.com/kaarmu/typst.vim
- Owner: kaarmu
- License: mit
- Created: 2023-03-24T11:58:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-14T12:02:41.000Z (3 months ago)
- Last Synced: 2024-04-14T12:18:11.322Z (3 months ago)
- Language: Vim Script
- Size: 116 KB
- Stars: 242
- Watchers: 4
- Forks: 23
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-typst - typst.vim - Vim plugin for Typst (Integrations & Tools / Editor Integrations)
- awesome-typst-cn - typst.vim
README
# typst.vim
*OBS: Work In Progress*
(Neo)vim plugin for [Typst](https://typst.app).
I am applying the 80/20 rule in this project since I prefer to have
something now rather than waiting for everything later.
## Features
*Editing [typst-palette](https://github.com/kaarmu/typst-palette) in Vim with the gruvbox colorscheme*
**Existing**
- Vim syntax highlighting.
- Compile the active document with `:make`.
- Concealing for italic, bold. Can be enabled with `g:typst_conceal`.
- Concealing symbols in math mode. Can be enabled with `g:typst_conceal_math`.
- Emojis! Can be enabled with `g:typst_conceal_emoji`.
- Syntax highlighting of code blocks. See `g:typst_embedded_languages`.
**Possible features**
- Formatting using [this](https://github.com/astrale-sharp/typst-fmt/)?
- Even better highlighting for neovim using treesitter?
Do you miss anything from other packages, e.g. `vimtex`, create an issue
and I'll probably add it! Also feel free to make a PR!
## Installation
### packer.nvim
```lua
require('packer').startup(function(use)
use {'kaarmu/typst.vim', ft = {'typst'}}
end)
```
- Call `:so %` or restart neovim to reload config
- Call `:PackerSync`
### lazy.nvim
```lua
return {
'kaarmu/typst.vim',
ft = 'typst',
lazy=false,
}
```
### vim-plug
```vim
call plug#begin('~/.vim/plugged')
Plug 'kaarmu/typst.vim'
call plug#end()
```
- Restart (neo)vim to reload config
- Call `:PlugInstall`
## Usage
### Options
- `g:typst_syntax_highlight`:
Enable syntax highlighting.
*Default:* `1`
- `g:typst_cmd`:
Specifies the location of the Typst executable.
*Default:* `'typst'`
- `g:typst_pdf_viewer`:
Specifies pdf viewer that `typst watch --open` will use.
*Default:* `''`
- `g:typst_conceal`:
Enable concealment.
*Default:* `0`
- `g:typst_conceal_math`:
Enable concealment for math symbols in math mode (i.e. replaces symbols
with their actual unicode character). **OBS**: this can affect performance,
see issue [#64](https://github.com/kaarmu/typst.vim/issues/64).
*Default:* `g:typst_conceal`
- `g:typst_conceal_emoji`:
Enable concealing emojis, e.g. `#emoji.alien` becomes 👽.
*Default:* `g:typst_conceal`
- `g:typst_auto_close_toc`:
Specifies whether TOC will be automatically closed after using it.
*Default:* `0`
- `g:typst_auto_open_quickfix`:
Specifies whether the quickfix list should automatically open when there are errors from typst.
*Default:* `1`
- `g:typst_embedded_languages`:
A list of languages that will be highlighted in code blocks. Typst is always highlighted.
*Default:* `[]`
### Commands
- `:TypstWatch`:
Watches your document and recompiles on change; also opens the document with your default pdf viewer.
## Tips
If you are using `neovim` you can install [typst-lsp](https://github.com/nvarner/typst-lsp).
There exist a server configuration in `nvim-lspconfig` so it should be easy to set it up. The
config currently requires that you're working in a git repo. Once the neovim+LSP recognizes
the file the LSP will compile your document while you write (almost like a wysiwyg!). By default
it will compile on save but you can set it to compile-on-write as well.