https://github.com/arne314/typstar

Neovim plugin for efficient note taking in typst
https://github.com/arne314/typstar

anki excalidraw nvim-plugin treesitter typst

Last synced: 9 days ago
JSON representation

Neovim plugin for efficient note taking in typst

• Host: GitHub
• URL: https://github.com/arne314/typstar
• Owner: arne314
• Created: 2024-11-01T22:51:51.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-30T22:49:50.000Z (9 days ago)
• Last Synced: 2024-12-30T23:25:53.251Z (9 days ago)
• Topics: anki, excalidraw, nvim-plugin, treesitter, typst
• Language: Lua
• Homepage:
• Size: 226 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Typstar

Neovim plugin for efficient note taking in typst

## Features

- Powerful autosnippets using [LuaSnip](https://github.com/L3MON4D3/LuaSnip/) and [Tree-sitter](https://tree-sitter.github.io/) (inspired by [fastex.nvim](https://github.com/lentilus/fastex.nvim))

- Easy insertion of drawings using [Obsidian Excalidraw](https://github.com/zsviczian/obsidian-excalidraw-plugin)

- \[WIP\] Export of [Anki](https://apps.ankiweb.net/) flashcards

## Usage

### Snippets

Use `:TypstarToggleSnippets` to toggle all snippets at any time.

Available snippets can mostly be intuitively derived from [here](././lua/typstar/snippets), they include:

- Alphanumeric characters: `:` → `$$ ` in markup (e.g. `:X` → `$X$ `, `:5` → `$5$ `)

- Greek letters: `;` → `` in math and `$$ ` in markup (e.g. `;a` → `alpha`/`$alpha$ `)

- Common indices (numbers and letters `i-m`): `` → `_` in math and `$$ ` → `$_$ ` in markup (e.g `A314` → `A_314`, `$alpha$n ` → `$alpha_n$ `)

- Wrapping of any mathematical expression (see [operations](./lua/typstar/snippets/visual.lua), works nested, multiline and in visual mode via the [selection key](#installation)): `` → `()` (e.g. `(a^2+b^2)rt` → `sqrt(a^2+b^2)`, `lambdatd` → `tilde(lambda)`, `(1+1)sQ` → `[1+1]`, `(1+1)sq` → `[(1+1)]`)

- Matrices: `ma` and `lma` (e.g. `23ma` → 2x3 matrix)

- [ctheorems shorthands](./lua/typstar/snippets/document.lua) (e.g. `tem` → empty theorem, `exa` → empty example)

- [Many shorthands](./lua/typstar/snippets/math.lua) for mathematical expressions

Note that you can enable and disable collections of snippets in the [config](#configuration).

### Excalidraw

Use `:TypstarInsertExcalidraw` to create a new drawing using the configured template, insert a figure displaying it and open it in Obsidian.

To open an inserted drawing in Obsidian, simply run `:TypstarOpenExcalidraw` while your cursor is on a line referencing the drawing.

### Anki

WIP

## Installation

Install the plugin in neovim and set the `typstarRoot` config or alternatively clone typstar into `~/typstar`.

```lua

require('typstar').setup({

  typstarRoot = '/path/to/typstar/repo' -- depending on your nvim plugin system

})

```

### Snippets

1. Install [LuaSnip](https://github.com/L3MON4D3/LuaSnip/), set `enable_autosnippets = true` and set a visual mode selection key (e.g. `store_selection_keys = ''`) in the configuration

2. Install [jsregexp](https://github.com/kmarius/jsregexp) as described [here](https://github.com/L3MON4D3/LuaSnip/blob/master/DOC.md#transformations) (running `:lua require('jsregexp')` in nvim should not result in an error)

3. Install [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) and run `:TSInstall typst`

4. Optional: Setup [ctheorems](https://typst.app/universe/package/ctheorems/) with names like [here](./lua/typstar/snippets/document.lua)

### Excalidraw

1. Install [Obsidian](https://obsidian.md/) and create a vault in your typst note taking directory

2. Install the [obsidian-excalidraw-plugin](https://github.com/zsviczian/obsidian-excalidraw-plugin) and enable `Auto-export SVG` (in plugin settings at `Embedding Excalidraw into your Notes and Exporting > Export Settings > Auto-export Settings`)

3. Have the `xdg-open` command working or set a different command at `uriOpenCommand` in the [config](#configuration)

### Anki

WIP

## Configuration

Configuration options can be intuitively derived from the table [here](./lua/typstar/config.lua).