language-servers/tinymist
1
0
Fork 0
mirror of https://github.com/Myriad-Dreamin/tinymist.git synced 2025-08-03 17:58:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 12
Tinymist [ˈtaɪni mɪst] is an integrated language service for Typst [taɪpst].
230 commits 54 branches 128 tags 242 MiB
Find a file
QuarticCat ebed95cbcd
fix: improve release profile & fix typos (#177) 
* dev: split a gh-release profile to accelerate development

* fix: many typos

* fix: miri warnings

* fix: update fixtures
2024-04-10 11:34:18 +08:00
.github fix: improve release profile & fix typos (#177) 2024-04-10 11:34:18 +08:00
.vscode fix: improve release profile & fix typos (#177) 2024-04-10 11:34:18 +08:00
crates fix: improve release profile & fix typos (#177) 2024-04-10 11:34:18 +08:00
editors fix: improve release profile & fix typos (#177) 2024-04-10 11:34:18 +08:00
scripts chore: fix test scripts and update test documents (#178) 2024-04-09 12:37:01 +08:00
syntaxes/textmate fix: improve release profile & fix typos (#177) 2024-04-10 11:34:18 +08:00
tests feat: add basic color providers (#171) 2024-04-06 14:10:48 +08:00
tools/editor-tools fix: improve release profile & fix typos (#177) 2024-04-10 11:34:18 +08:00
.gitignore docs: introduce language features 2024-03-09 17:20:20 +08:00
.prettierignore dev: init 2024-03-07 05:29:31 +08:00
Cargo.lock build: bump version to 0.11.3 (#172) 2024-04-06 19:46:41 +08:00
Cargo.toml fix: improve release profile & fix typos (#177) 2024-04-10 11:34:18 +08:00
CHANGELOG.md build: bump version to 0.11.2 (#136) 2024-03-30 23:02:43 +08:00
CONTRIBUTING.md chore: fix test scripts and update test documents (#178) 2024-04-09 12:37:01 +08:00
LICENSE dev: init 2024-03-07 05:29:31 +08:00
package.json feat: add template gallery as template picker (#52) 2024-03-16 22:23:09 +08:00
README.md build: bump version to 0.11.3 (#172) 2024-04-06 19:46:41 +08:00
yarn.lock fix: improve release profile & fix typos (#177) 2024-04-10 11:34:18 +08:00

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:

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.

Contributing

Please read the CONTRIBUTING.md file for contribution guidelines.

Acknowledgements