tinymist/README.md

Tinymist

Tinymist [ˈtaɪni mɪst] is an integrated language service for Typst [taɪpst]. You can also call it "微霭" [wēi ǎi] in Chinese.

It contains:

• an analyzing library for Typst, see tinymist-query.
• a CLI for Typst, see tinymist.
  • which provides a language server for Typst.
• a VSCode extension for Typst, see Tinymist VSCode Extension.

Features

Language service (LSP) features:

• Semantic highlighting
  • Also known as "syntax highlighting".
• Diagnostics
  • Also known as "error checking" or "error reporting".
• Document symbols
  • Also known as "document outline" or "table of contents" in Typst.
• Folding ranges
  • You can collapse code/content blocks and headings.
• Goto definitions
  • Right-click on a symbol and select "Go to Definition".
  • Or ctrl+click on a symbol.
• Goto declarations
  • Also known as "find all references".
• Hover tips
  • Also known as "hovering tooltip".
• Inlay hints
  • Inlay hints are special markers that appear in the editor and provide you with additional information about your code, like the names of the parameters that a called method expects.
• Rename symbols
• Help with function and method signatures
• Workspace Symbols

Extra features:

• Compiles to PDF on save (configurable to as-you-type, or can be disabled)

Installation

Follow the instructions to enable tinymist in your favorite editor.

• VSCode

Acknowledgements

• It is developed based on typst-lsp