From 163b6622e88e999e8a2524e6b0added3ad0d8659 Mon Sep 17 00:00:00 2001 From: Elijan Mastnak Date: Tue, 20 Sep 2022 08:14:08 +0200 Subject: [PATCH 1/3] chore: update ejmastnak tutorial URLs --- README.md | 4 ++-- VISUALS.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2f1259404c..294cf95b8b 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,7 @@ https://user-images.githubusercontent.com/66584581/119213849-1b7d4080-ba77-11eb- Both new and experienced users are also encouraged to read the third-party article [Getting started with the VimTeX -plugin](https://ejmastnak.github.io/tutorials/vim-latex/vimtex.html). The +plugin](https://www.ejmastnak.com/tutorials/vim-latex/vimtex.html). The article covers VimTeX's core features and contains plenty of examples and high-resolution animations intended to help new users ease into working with the plugin. @@ -321,7 +321,7 @@ plugins for Vim, see: VimTeX users may be interested in reading [@ejmastnak](https://github.com/ejmastnak)'s series on [Efficient LaTeX Using -(Neo)Vim](https://ejmastnak.github.io/tutorials/vim-latex/intro.html), which +(Neo)Vim](https://www.ejmastnak.com/tutorials/vim-latex/intro.html), which covers all the fundamentals of setting up a VimTeX-based LaTeX workflow, including usage of the VimTeX plugin, compilation, setting up forward and inverse search with a PDF reader, and Vimscript tools for user-specific diff --git a/VISUALS.md b/VISUALS.md index 61f4cfbd96..1d59e12b05 100644 --- a/VISUALS.md +++ b/VISUALS.md @@ -5,7 +5,7 @@ editing features listed in `:help vimtex-features`. The related mappings are documented in detail at `:help vimtex-mappings`. The GIFs and accompanying descriptions are used with permission from [@ejmastnak](https://github.com/ejmastnak)'s guide to [Getting started with the -VimTeX plugin](https://ejmastnak.github.io/tutorials/vim-latex/vimtex.html). +VimTeX plugin](https://www.ejmastnak.com/tutorials/vim-latex/vimtex.html). Hopefully, the animations can give you a clearer mental image of what VimTeX's mappings do and how you might use them. You may want to scroll through this page From 3444fbd0283833b7111073bc7b4867e9fac160f3 Mon Sep 17 00:00:00 2001 From: Elijan Mastnak Date: Tue, 20 Sep 2022 08:23:25 +0200 Subject: [PATCH 2/3] doc: make links to GIFs slightly easier to find My thinking: I was looking through the README from the perspective of a new user (who will probably just be skimming on a first pass and might have a mild case of information overload) and realized I made the GIFs a bit difficult to find in my initial PR [#2362](https://github.com/lervag/vimtex/pull/2362). So I've added: - a few headings specifically for GIFs - links in the Features section immediately next to the corresponding feature, instead of tucked away at the bottom of the list of features. --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 294cf95b8b..53a8b9404a 100644 --- a/README.md +++ b/README.md @@ -126,6 +126,8 @@ basic functions. https://user-images.githubusercontent.com/66584581/119213849-1b7d4080-ba77-11eb-8a31-7ff7b9a4a020.mp4 +### Tutorial + Both new and experienced users are also encouraged to read the third-party article [Getting started with the VimTeX plugin](https://www.ejmastnak.com/tutorials/vim-latex/vimtex.html). The @@ -133,6 +135,8 @@ article covers VimTeX's core features and contains plenty of examples and high-resolution animations intended to help new users ease into working with the plugin. +### Documentation + Users are of course _strongly_ encouraged to read the documentation, at least the introduction, to learn about the different features and possibilities provided by VimTeX (see [`:h vimtex`](doc/vimtex.txt)). Advanced users and @@ -142,7 +146,7 @@ documents: * [CONTRIBUTING.md](CONTRIBUTING.md) * [DOCUMENTATION.md](DOCUMENTATION.md) -## Screenshots and GIFs +## Screenshots Here is an example of the syntax highlighting provided by VimTeX. The conceal feature is active on the right-hand side split. The example is made by @@ -153,8 +157,10 @@ here](https://github.com/lervag/vimtex/issues/1946#issuecomment-843674951). ![Syntax example](https://github.com/lervag/vimtex-media/blob/main/img/syntax.png) -Additionally, you can find animated demonstrations of VimTeX's core motions, -text-editing commands, and text objects in the file [VISUALS.md](VISUALS.md). +### GIFs + +See the file [VISUALS.md](VISUALS.md) for screencast-style GIFs demonstrating +VimTeX's core motions, text-editing commands, and text objects. ## Features @@ -198,21 +204,21 @@ by default and must be manually enabled. - give enhanced `gf` command - Easy access to (online) documentation of packages - Word count (through `texcount`) -- Motions +- Motions ([link to GIF demonstrations](VISUALS.md#motion-commands)) - Move between section boundaries with `[[`, `[]`, `][`, and `]]` - Move between environment boundaries with `[m`, `[M`, `]m`, and `]M` - Move between math environment boundaries with `[n`, `[N`, `]n`, and `]N` - Move between frame environment boundaries with `[r`, `[R`, `]r`, and `]R` - Move between comment boundaries with `[*` and `]*` - Move between matching delimiters with `%` -- Text objects +- Text objects ([link to GIF demonstrations](VISUALS.md#text-objects)) - `ic ac` Commands - `id ad` Delimiters - `ie ae` LaTeX environments - `i$ a$` Math environments - `iP aP` Sections - `im am` Items -- Other mappings +- Other mappings ([link to GIF demonstrations](VISUALS.md#deleting-surrounding-latex-content)) - Delete the surrounding command, environment or delimiter with `dsc`/`dse`/`ds$`/`dsd` - Change the surrounding command, environment or delimiter with @@ -237,10 +243,6 @@ by default and must be manually enabled. - [import](http://ctan.uib.no/macros/latex/contrib/import/import.pdf) - [subfiles](http://ctan.uib.no/macros/latex/contrib/subfiles/subfiles.pdf) -For orientation, you can watch concise demonstrations of many of the motions, -text objects, and text-editing features provided by VimTeX in the file -[VISUALS.md](VISUALS.md). - See the documentation for a thorough introduction to VimTeX (e.g. `:h vimtex`). ## Other relevant plugins From 536fe99c61e2d0b7538717e052bc1aec1b367d62 Mon Sep 17 00:00:00 2001 From: Elijan Mastnak Date: Tue, 20 Sep 2022 08:33:40 +0200 Subject: [PATCH 3/3] doc: update README TOC with new sections --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 53a8b9404a..b464998ee2 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,10 @@ filetype and syntax plugin for LaTeX files. - [Installation](#installation) - [Configuration](#configuration) - [Quick Start](#quick-start) -- [Screenshots and GIFs](#screenshots-and-gifs) + - [Tutorial](#tutorial) + - [Documentation](#documentation) +- [Screenshots](#screenshots) + - [GIFs](#gifs) - [Features](#features) - [Other relevant plugins](#other-relevant-plugins) - [Linting and syntax checking](#linting-and-syntax-checking)