Skip to content

Commit

Permalink
doc: added syntax example image
Browse files Browse the repository at this point in the history
refer: #1946
  • Loading branch information
lervag committed May 22, 2021
1 parent f5c445f commit e7d0fc2
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,21 @@ most basic features. Users are _strongly_ encouraged to read or at least skim
through the documentation to learn about the different features and
possibilities provided by VimTeX (see [`:h vimtex`](doc/vimtex.txt)).

![Quick start gif](media/quick_start.gif?raw=true)
![Quick start gif](https://github.com/lervag/vimtex-media/blob/main/video/quick_start.gif?raw=true)

Advanced users and potential developers may also be interested in reading the
supplementary documents:

* [CONTRIBUTING.md](CONTRIBUTING.md)
* [DOCUMENTATION.md](DOCUMENTATION.md)

Here is an example of the syntax highlighting provided by VimTeX. The example
is made with the [vim-colors-xcode](https://github.com/arzg/vim-colors-xcode)
colorscheme with some minor adjustments [described
here](https://github.com/lervag/vimtex/issues/1946#issuecomment-843674951).

![Syntax example](https://github.com/lervag/vimtex-media/blob/main/img/syntax.png)

## Features

Below is a list of features offered by VimTeX. The features are accessible as
Expand Down
Binary file removed media/quick_start.gif
Binary file not shown.

0 comments on commit e7d0fc2

Please sign in to comment.