add info about tinymist and show how to pass initialization options to it #2473
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for sublime-lsp ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
istudyatuni
force-pushed
the
typst-tinymist
branch
from
38d3516
to
cb16d7b
Compare
rchl
reviewed
May 11, 2024
Comment on lines
+783
to
+789
| "tinymist": { | ||
| // ... | ||
| "initializationOptions": { | ||
| "exportPdf": "never", | ||
| "typstExtraArgs": [], | ||
| } | ||
| } |
There was a problem hiding this comment.
It can be confusing to show the tinymist object as a root object. You should have the parent clients here also, like in the previous snippet.
| @@ -793,7 +807,7 @@ See [Javascript/TypeScript](#javascripttypescript). | |||
| <!-- how to call: see https://github.com/nvarner/typst-lsp/blob/master/editors/vscode/src/extension.ts --> | |||
| ```jsonc title="Packages/User/Default.sublime-commands" | |||
| [ | |||
| // ... | |||
| // typst-lsp: | |||
There was a problem hiding this comment.
// ... were supposed to signify that there might be other content in this file also.
rchl
reviewed
May 11, 2024
Comment on lines
+763
to
+789
| 2. There are 2 available languages servers, and their configuration is mostly the same: | ||
| 1. [tinymist](https://github.com/Myriad-Dreamin/tinymist) - has more features, like go to definition, rename, etc. | ||
| 2. [typst-lsp](https://github.com/nvarner/typst-lsp/releases). | ||
| 3. Open `Preferences > Package Settings > LSP > Settings` and add the `"typst-lsp"` client configuration to the `"clients"`: | ||
|
|
||
| ```jsonc | ||
| { | ||
| "clients": { | ||
| "typst-lsp": { | ||
| "enabled": true, | ||
| "command": ["C:\\path\\to\\typst-lsp-win32-x64.exe"], // adjust this path according to your platform/setup | ||
| "command": ["path/to/typst-lsp"], // adjust this path according to your platform/setup | ||
| "selector": "text.typst" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| If you want to provide some initialization options to tinymist, like exportPdf of typstExtraArgs, set it like | ||
|
|
||
| ```jsonc | ||
| "tinymist": { | ||
| // ... | ||
| "initializationOptions": { | ||
| "exportPdf": "never", | ||
| "typstExtraArgs": [], | ||
| } | ||
| } |
There was a problem hiding this comment.
If there exist two servers then this section should be refactored to have the ## Typst header and two separate ### ... sub headers for each server. See Python section for example.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.