2024-12-22 18:58:17 +01:00
2024-12-22 18:58:17 +01:00
2024-10-31 13:21:20 +01:00
2024-12-14 23:22:12 +01:00

Typstar

Neovim plugin for efficient note taking in typst

Features

Usage

Snippets

Use :TypstarToggleSnippets to toggle all snippets at any time. Available snippets can mostly be intuitively derived from here, they include:

  • Alphanumeric characters: :<char>$<char>$ in markup (e.g. :X$X$ , :5$5$ )
  • Greek letters: ;<latin><greek> in math and $<greek>$ in markup (e.g. ;aalpha/$alpha$ )
  • Common indices (numbers and letters i-m): <letter><index><letter>_<index> in math and $<letter>$<index> $<letter>_<index>$ in markup (e.g A314A_314, $alpha$n $alpha_n$ )
  • Wrapping of any mathematical expression (see operations, works nested, multiline and in visual mode via the selection key): <expression><operation><operation>(<expression>) (e.g. (a^2+b^2)rtsqrt(a^2+b^2), lambdatdtilde(lambda), (1+1)sQ[1+1], (1+1)sq[(1+1)])
  • Matrices: <size>ma and <size>lma (e.g. 23ma → 2x3 matrix)
  • ctheorems shorthands (e.g. tem → empty theorem, exa → empty example)
  • Many shorthands for mathematical expressions

Note that you can enable and disable collections of snippets in the config.

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.

require('typstar').setup({
  typstarRoot = '/path/to/typstar/repo' -- depending on your nvim plugin system
})

Snippets

  1. Install LuaSnip, set enable_autosnippets = true and set a visual mode selection key (e.g. store_selection_keys = '<Tab>') in the configuration
  2. Install jsregexp as described here (running :lua require('jsregexp') in nvim should not result in an error)
  3. Install nvim-treesitter and run :TSInstall typst
  4. Optional: Setup ctheorems with names like here

Excalidraw

  1. Install Obsidian and create a vault in your typst note taking directory
  2. Install the 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

Anki

WIP

Configuration

Configuration options can be intuitively derived from the table here.

Description
No description provided
Readme 357 KiB
Languages
Lua 63.2%
Python 32.7%
Nix 4.1%