Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
XadillaX committed Mar 11, 2022
1 parent 7e70ed2 commit c03dc51
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 27 deletions.
66 changes: 39 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,48 @@
# VSCode VimL
<p align="center">
<img height="200" src="https://github.com/XadillaX/vscode-language-viml/raw/master/assets/README.png" />
</p>

[![GitHub issues](https://img.shields.io/github/issues/XadillaX/vscode-language-viml.svg)](https://github.com/XadillaX/vscode-language-viml/issues)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/XadillaX/vscode-language-viml/blob/master/LICENSE)
[![Version](https://vsmarketplacebadge.apphb.com/version-short/XadillaX.viml.svg?style=flat&color=blue)](https://marketplace.visualstudio.com/items?itemName=XadillaX.viml)
<p align="center">
<a href="https://marketplace.visualstudio.com/items?itemName=XadillaX.viml">
<img src="https://vsmarketplacebadge.apphb.com/version-short/XadillaX.viml.svg?style=for-the-badge&colorA=FF7800&colorB=CC5600&label=VS%20MARKETPLACE" />
</a>
<a href="https://marketplace.visualstudio.com/items?itemName=XadillaX.viml">
<img src="https://vsmarketplacebadge.apphb.com/downloads-short/XadillaX.viml.svg?style=for-the-badge&colorA=5DDB61&colorB=4BC74F&label=DOWNLOADS" />
</a>
<a href="https://marketplace.visualstudio.com/items?itemName=XadillaX.viml">
<img src="https://vsmarketplacebadge.apphb.com/rating-star/XadillaX.viml.svg?style=for-the-badge&colorA=FBBD30&colorB=F2AA08" />
</a>
</p>

Vim Script language support for VSCode.
## What does this extension do?

> Syntax Highlighting is synchronized from [Atom VimL](https://github.com/Alhadis/language-viml) with ❤ by [vscode-grammar-update-tool](https://github.com/XadillaX/vscode-update-grammar-tool).
[**VimL**](https://en.wikipedia.org/wiki/Vim_(text_editor)#Vim_script) (Also known as **Vim Language**, **VimScript**) support for [VSCode](https://code.visualstudio.com/).

Syntax Highlighting is synchronized from [Atom VimL](https://github.com/Alhadis/language-viml) with ❤ by [vscode-grammar-update-tool](https://github.com/XadillaX/vscode-update-grammar-tool).

Language Server Protocol depends on [vim-language-server](https://github.com/iamcco/vim-language-server).

> Thanks to [Alhadis/language-viml](https://github.com/Alhadis/language-viml), [iamcco/vim-language-server](https://github.com/iamcco/vim-language-server) and [XadillaX/vscode-update-grammar-tool](https://github.com/XadillaX/vscode-update-grammar-tool).
## Features

+ Syntax highlighting for VimL files;
+ Syntax highlighting for VimL in Markdown;
+ Syntax highlighting for Vim Help files and Vim Snippet files;
+ By default, the following file types will be highlighted:
- `*.vim`
- `*.vimrc` / `_vimrc`
- `*.gvimrc`
- `*.ideavim` / `.ideavim` / `.ideavimrc`
- `*.exrc`
+ Language Server Protocol (By https://github.com/iamcco/vim-language-server)
- Auto completion;
- Function signature help;
- Hover document;
- Go to definition;
- Go to references;
- Document symbols;
- Folding range;
- Select range;
- Rename;
- Snippets;
- Diagnostic.
+ Language Server Protocol (Refer to [vim-language-server](https://github.com/iamcco/vim-language-server)):
- Auto completion;
- Function signature help;
- Hover document;
- Go to definition;
- Go to references;
- Document symbols;
- Folding range;
- Select range;
- Rename;
- Snippets;
- Diagnostic;
+ Syntax highlighting for
- **VimL files** (`*.vim`, `*.vimrc`, `_vimrc`, `*.gvimrc`, `*.ideavim`, `.ideavim`, `.ideavimrc`, `*.exrc`, etc);
- **Vim Help files** (`*.txt` with matching a certain RegExp in file);
- **Vim Snippet files** (`*.snip`, `*.snippet`, `*.snippets`, etc);
+ Syntax highlighting for embedding **Vim related syntaxes** (see above) in **Markdown files**.

## Contribution

Expand Down
Binary file added assets/README.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c03dc51

Please sign in to comment.