# 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) - Export of [Anki](https://apps.ankiweb.net/) flashcards \[No Neovim required\] ## 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: Markup snippets: - Begin inline math with `ll` and multiline math with `dm` - [Markup shorthands](./lua/typstar/snippets/markup.lua) (e.g. `HIG` → `#highlight[]`, `IMP` → `$==>$ `) - [ctheorems shorthands](./lua/typstar/snippets/markup.lua) (e.g. `tem` → empty theorem, `exa` → empty example) - [Flashcards](#anki): `fla` and `flA` - All above snippets support visual mode via the [selection key](#installation) Math snippets: - [Many shorthands](./lua/typstar/snippets/math.lua) for mathematical expressions - 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-n`): ` ` → `_ ` in math and `$$ ` → `$_$ ` in markup (e.g `A314 ` → `A_314 `, `$alpha$n ` → `$alpha_n$ `) - Series of numbered letters: ` ot ` → `_1, _2, ... ` (e.g. `a ot ` → `a_1, a_2, ... `, `a ot4 ` → `a_1, a_2, a_3, a_4 `, `alpha ot k ` → `alpha_1, alpha_2, ..., alpha_k `) - 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) Note that you can enable and disable single and modules 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 Use the `flA` snippet to create a new flashcard ```typst #flashcard(0, "My first flashcard")[ Typst is awesome $a^2+b^2=c^2$ ] ``` or the `fla` snippet to add a more complex front ```typst #flashcard(0)[I love Typst $pi$][ This is the back of my second flashcard ] ``` To render the flashcard in your document as well add some code like this ```typst #let flashcard(id, front, back) = { strong(front) [\ ] back } ``` - Add a comment like `// ANKI: MY::DECK` to your document to set a deck used for all flashcards after this comment (You can use multiple decks per file) - Add a file named `.anki` containing a deck name to define a default deck on a directory base - Add a file named `.anki.typ` to define a preamble on a directory base. You can find the default preamble [here](./src/anki/typst_compiler.py). - Tip: Despite the use of SVGs you can still search your flashcards in Anki as the typst source is added into an invisible html paragraph #### Neovim - Use `:TypstarAnkiScan` to scan the current nvim working directory and compile all flashcards in its context, unchanged files will be ignored - Use `:TypstarAnkiForce` to force compilation of all flashcards in the current working directory even if the files haven't changed since the last scan (e.g. on preamble change) - Use `:TypstarAnkiForceCurrent` to force compilation of all flashcards in the file currently edited - Use `:TypstarAnkiReimport` to also add flashcards that have already been asigned an id but are not currently present in Anki - Use `:TypstarAnkiForceReimport` and `:TypstarAnkiForceCurrentReimport` to combine features accordingly #### Standalone - Run `typstar-anki --help` to show the available options ## Installation Install the plugin in Neovim and run the plugin setup. ```lua require('typstar').setup({ -- depending on your neovim plugin system -- your typstar config goes here }) ``` ### In a Nix Flake You can add typstart to your `nix-flake` like so: ```nix # `flake.nix` inputs = { # ... other inputs typstar = { url = "github:arne314/typstar"; flake = false; }; } ``` Now you can use `typstar` in any package-set ```nix with pkgs [ # # other packges ... # (pkgs.vimUtils.buildVimPlugin { name = "typstar"; src = inputs.typstar; buildInputs = [ vimPlugins.luasnip vimPlugins.nvim-treesitter-parsers.typst ]; }) ] ``` ### 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) (You will see a warning on startup if jsregexp isn't installed properly) 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/markup.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) 4. If you encounter issues try cloning the repo into `~/typstar` or setting the `typstarRoot` config accordingly, feel free to open an issue ### Anki 0. Typst version `0.12.0` or higher is required 1. Install [Anki](https://apps.ankiweb.net/#download) 2. Install [Anki-Connect](https://ankiweb.net/shared/info/2055492159) and make sure `http://localhost` is added to `webCorsOriginList` in the Add-on config (should be added by default) 3. Install the typstar python package (I recommend using [pipx](https://github.com/pypa/pipx) via `pipx install git+https://github.com/arne314/typstar`, you will need to have python build tools and clang installed) \[Note: this may take a while\] 4. Make sure the `typstar-anki` command is available in your `PATH` or modify the `typstarAnkiCmd` option in the [config](#configuration) ## Configuration Configuration options can be intuitively derived from the table [here](./lua/typstar/config.lua).