mirror of
https://github.com/Myriad-Dreamin/tinymist.git
synced 2025-08-03 17:58:17 +00:00
Tinymist [ˈtaɪni mɪst] is an integrated language service for Typst [taɪpst].
.github | ||
.vscode | ||
crates | ||
editors | ||
scripts | ||
syntaxes/textmate | ||
tests | ||
tools/editor-tools | ||
.gitignore | ||
.prettierignore | ||
Cargo.lock | ||
Cargo.toml | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
LICENSE | ||
package.json | ||
README.md | ||
yarn.lock |
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.
- 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)
- Editor tools:
- View a list of templates in template gallery.
- Click a button in template gallery to initialize a new project with a template.
Installation
Follow the instructions to enable tinymist in your favorite editor.
Contributing
Please read the CONTRIBUTING.md file for contribution guidelines.
Acknowledgements
- Partially code is inherited from typst-lsp