Skip to content

Commit

Permalink
docs: Add Vue JS docs
Browse files Browse the repository at this point in the history
Signed-off-by: azerr <[email protected]>
  • Loading branch information
angelozerr committed Dec 23, 2024
1 parent d878977 commit e211838
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/UserDefinedLanguageServer.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ pre-filled with server name, command, mappings and potential configuration.
* [Scala Language Server (Metals)](./user-defined-ls/metals.md)
* [SourceKit-LSP](./user-defined-ls/sourcekit-lsp.md)
* [TypeScript Language Server](./user-defined-ls/typescript-language-server.md)
* [Vue Language Server](./user-defined-ls/vue-js-language-server.md)

If the template directory contains a `README.md` file, you can open the instructions by pressing the help icon.

Expand Down
25 changes: 25 additions & 0 deletions docs/user-defined-ls/vue-js-language-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
You can use [Vue Language Server](https://github.com/vuejs/language-tools/tree/master/packages/language-server) by following these instructions:
* [Install Node.js](https://nodejs.org/en/download)
* [npm install -g @vue/language-server](https://www.npmjs.com/package/@volar/vue-language-server)
* [npm install -g typescript](https://www.npmjs.com/package/typescript)

Configure, example on windows:
* Server > Command > `vue-language-server.cmd --stdio` OR `node "C:/Users/${user.name}/AppData/Roaming/npm/node_modules/@vue/language-server/bin/vue-language-server.js" --stdio`
* Mappings > File name patterns > press "+" > File name patterns like "`*.vue`" and language id like "`vue`"
* Configuration: `{}`
* Initialization Options, need set `${user.name}`:
``` JSON
{
"typescript": {
"tsdk": "C:/Users/${user.name}/AppData/Roaming/npm/node_modules/typescript/lib"
},
"vue": {
"hybridMode": false
}
}
```

You can use [Vue highlight](https://github.com/vuejs/vue-syntax-highlight) in the TextMate by following these instructions:
* Download and unzip in a folder
* File -> Settings -> Editor -> TextMate Bundles
* And press "+" `Select Path` to folder with highlight

0 comments on commit e211838

Please sign in to comment.