Skip to content

pickoba/satysfi-workshop

Repository files navigation

SATySFi Workshop

CI Visual Studio Marketplace

This extension provides language support for SATySFi.

Note: This project is forked from wraikny/vscode-satysfi.

Features

Building

Building

You can build your SATySFi documents from the button (top right) and keyboard shortcuts (ctrl/cmd + alt + b). You can also set it to build automatically when you save the file.

Note: This extension does not include a pdf viewer. If you need it, please install vscode-pdf or LaTeX Workshop etc.

Type Checking

Type Checking

Type checking can be performed automatically when typing or saving a document.

Package Completion

Package Completion

Package name completion based on SATySFi installation.

Language Server Support

Language Server

The language server provides completion and explanation of commands and variables.

This extension does not include the language server itself. You have to clone & build monaqa/satysfi-language-server on your own and configure as follows.

{
  "satysfi-workshop.languageServer.enabled": true,
  "satysfi-workshop.languageServer.path": "/path/to/language server"
}

Math Preview

Math Preview

Preview the formula by hovering the mouse cursor over it.

To use this feature, you need to install pdf2svg, which can be installed with apt (Ubuntu/WSL) or Homebrew (macOS). Here is an example configuration:

{
  "satysfi-workshop.mathPreview.when": "onHover"
}

Credits

I would like to express my gratitude to @wraikny, the original author of vscode-satysfi.

License

Apache License 2.0, See LICENSE for more information.