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.
• References
  • Right-click on a symbol and select "Go to References" or "Find References".
  • Or ctrl+click on a symbol.
• 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.
• Color Provider
  • View all inlay colorful label for color literals in your document.
  • Change the color literal's value by a color picker or its code presentation.
• Code Lens
  • Should give contextual buttons along with code. For example, a button for exporting your document to various formats at the start of the document.
• Rename symbols
• Help with function and method signatures
• Workspace Symbols

Extra features:

• Compiles to PDF on save (configurable to as-you-type, or other options)
• Provides code lenses for exporting to various formats (PDF, SVG, PNG, etc.)
• Provides a status bar item to show the current document's compilation status and words count.
• Editor tools:
  • View a list of templates in template gallery. (tinymist.showTemplateGallery)
  • Click a button in template gallery to initialize a new project with a template. (tinymist.initTemplate and tinymist.initTemplateInPlace)
  • Trace execution in current document. (tinymist.traceCurrentFile)

Installation

Follow the instructions to enable tinymist in your favorite editor.

• Helix
• Neovim
• VSCode

Contributing

Please read the CONTRIBUTING.md file for contribution guidelines.

Acknowledgements

• Partially code is inherited from typst-lsp