tinymist/editors/vscode/README.md

Tinymist Typst VS Code Extension

A VS Code or VS Codium extension for Typst. You can find the extension on:

• Night versions available at GitHub Actions.
• Stable versions available at Visual Studio Marketplace.
• Stable versions available at Open VSX.

Features

See Tinymist Features for a list of features.

Usage Tips

Initializing with a Template

To initialize a Typst project:

• Use command Typst init template (tinymist.initTemplate) to initialize a new Typst project based on a template.
• Use command Typst show template (tinymist.showTemplateGallery) to show available Typst templates for picking up a template to initialize.

🎉 If your template contains only a single file, you can also insert the template content in place with command:

• Use command Typst template in place (tinymist.initTemplateInPlace) and input a template specifier for initialization.

Configuring LSP-enhanced formatters

1. Open settings.
2. Search for "Tinymist Formatter" and modify the value.

• Use "formatterMode": "typstyle" for typstyle.
• Use "formatterMode": "typstfmt" for typstfmt.

Tips: to enable formatting on save, you should add extra settings for typst language:

{
  "[typst]": {
    "editor.formatOnSave": true
  }
}

Configuring/Using Tinymist's Activity Bar (Sidebar)

If you don't like the activity bar, you can right-click on the activity bar and uncheck "Tinymist" to hide it.

Symbol View

• Search symbols by keywords, descriptions, or handwriting.
• See symbols grouped by categories.
• Click on a symbol, then it will be inserted into the editor.

Preview Command

Open command palette (Ctrl+Shift+P), and type >Typst Preview:.

You can also use the shortcut (Ctrl+K V).

Configuring path to search fonts

To configure path to search fonts:

1. Open settings.

• File -> Preferences -> Settings (Linux, Windows).
• Code -> Preferences -> Settings (Mac).

2. Search for "Tinymist Font Paths" for providing paths to search fonts order-by-order.
3. Search for "Tinymist No System Fonts" for disabling system fonts to be searched, which is useful for reproducible rendering your PDF documents.
4. Reload the window or restart the vscode editor to make the settings take effect. Note: you must provide absolute paths. Note': you can use vscode variables in the settings, see vscode-variables for more information.

Configuring path to root directory

To configure the root path resolved for Typst compiler:

1. Open settings.
2. Search for "Tinymist Root Path" and modify the value.
3. Reload the window or restart the vscode editor to make the settings take effect. Note: you must provide absolute paths.

Compiling PDF

This extension compiles to PDF, but it doesn't have a PDF viewer yet. To view the output as you work, install a PDF viewer extension, such as vscode-pdf.

To find a way to compile PDF:

• Click the code len Export PDF at the top of document, or use command Typst Show PDF ..., to show the current document to PDF.
• Use command Typst Export PDF to export the current document to PDF.
• There are code lens buttons at the start of the document to export your document to PDF or other formats.

To configure when PDFs are compiled:

1. Open settings.
2. Search for "Tinymist Export PDF".
3. Change the "Export PDF" setting.

• onSave makes a PDF after saving the Typst file.
• onType makes PDF files live, as you type.
• never disables PDF compilation.
• "onDocumentHasTitle" makes a PDF when the document has a title and, as you save.

To configure where PDFs are saved:

1. Open settings.
2. Search for "Tinymist Output Path".
3. Change the "Output Path" setting. This is the path pattern to store artifacts, you can use $root or $dir or $name to do magic configuration

• e.g. $root/$dir/$name (default) for $root/path/to/main.pdf.
• e.g. $root/target/$dir/$name for $root/target/path/to/main.pdf.
• e.g. $root/target/foo for $root/target/foo.pdf. This will ensure that the output is always output to target/foo.pdf.

4. Note: the output path should be substituted as an absolute path.

Working with Multiple-File Projects

You can pin a main file by command.

• Use command Typst Pin Main (tinymist.pinMainToCurrent) to set the current file as the main file.
• Use command Typst Unpin Main (tinymist.unpinMain) to unset the main file.

Passing Extra CLI Arguments

There is a global configuration tinymist.typstExtraArgs to pass extra arguments to tinymist LSP, like what you usually do with typst-cli CLI. For example, you can set it to ["--input=awa=1", "--input=abaaba=2", "main.typ"] to configure sys.inputs and entry for compiler, which is equivalent to make LSP run like a typst-cli with such arguments:

typst watch --input=awa=1 --input=abaaba=2 main.typ

Note: Fix entry to main.typ may help multiple-file projects but you may loss diagnostics and autocompletions in unrelated files.

Note: the arguments has quite low priority, and that may be overridden by other settings.

Contributing

You can submit issues or make PRs to GitHub.