Skip to content

Commit fa9f488

Browse files
committed
doc(README): better highlighting of notes, cautions and tips
1 parent c8412f4 commit fa9f488

File tree

1 file changed

+34
-25
lines changed

1 file changed

+34
-25
lines changed

README.md

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,14 @@ Users are encouraged to read the requirements section in the
4848
There are a lot of methods for installing plugins.
4949
The following explains the most common and popular approaches.
5050

51-
**Note**: Many plugin managers provide mechanisms to lazy load plugins. Please
52-
don't use this for VimTeX! VimTeX is already lazy loaded by virtue of being
53-
a filetype plugin and by using the autoload mechanisms. There is therefore
54-
nothing to gain by forcing VimTeX to lazily load through the plugin
55-
manager. In fact, doing it will _break_ the inverse-search mechanism, which
56-
relies on a _global_ command (`:VimtexInverseSearch`).
51+
> [!WARNING]
52+
>
53+
> Many plugin managers provide mechanisms to lazy load plugins. Please don't
54+
> use this for VimTeX! VimTeX is already lazy loaded by virtue of being
55+
> a filetype plugin and by using the autoload mechanisms. There is therefore
56+
> nothing to gain by forcing VimTeX to lazily load through the plugin manager.
57+
> In fact, doing it will _break_ the inverse-search mechanism, which relies on
58+
> a _global_ command (`:VimtexInverseSearch`).
5759
5860
### lazy.nvim
5961

@@ -92,20 +94,23 @@ Plug 'lervag/vimtex', { 'tag': 'v2.15' }
9294
There are many other plugin managers out there.
9395
They are typically well documented, and it should be straightforward to extrapolate the above snippets.
9496

95-
**Note**: If you use the built-in package feature, then:
96-
* Make sure to read and understand the package feature: `:help package`!
97-
* Use the `/pack/foo/start` subdirectory to make sure the filetype plugin is
98-
automatically loaded for the `tex` filetypes.
99-
* Helptags are not generated automatically. Run `:helptags` to generate them.
100-
* Please note that by default Vim puts custom `/start/` plugin directories at
101-
the end of the `&runtimepath`. This means the built in filetype plugin is
102-
loaded, which prevents VimTeX from loading. See
103-
[#1413](https://github.com/lervag/vimtex/issues/1413) for two suggested
104-
solutions to this. To see which scripts are loaded and in which order, use
105-
`:scriptnames`.
106-
* For more information on how to use the Vim native package solution, see
107-
[here](https://vi.stackexchange.com/questions/9522/what-is-the-vim8-package-feature-and-how-should-i-use-it)
108-
and [here](https://shapeshed.com/vim-packages/).
97+
> [!NOTE]
98+
>
99+
> If you use the built-in package feature, then:
100+
>
101+
> - Make sure to read and understand the package feature: `:help package`!
102+
> - Use the `/pack/foo/start` subdirectory to make sure the filetype plugin is
103+
> automatically loaded for the `tex` filetypes.
104+
> - Helptags are not generated automatically. Run `:helptags` to generate them.
105+
> - Please note that by default Vim puts custom `/start/` plugin directories at
106+
> the end of the `&runtimepath`. This means the built in filetype plugin is
107+
> loaded, which prevents VimTeX from loading. See
108+
> [#1413](https://github.com/lervag/vimtex/issues/1413) for two suggested
109+
> solutions to this. To see which scripts are loaded and in which order, use
110+
> `:scriptnames`.
111+
> - For more information on how to use the Vim native package solution, see
112+
> [here](https://vi.stackexchange.com/questions/9522/what-is-the-vim8-package-feature-and-how-should-i-use-it)
113+
> and [here](https://shapeshed.com/vim-packages/).
109114
110115
## Configuration
111116

@@ -114,7 +119,9 @@ to configure VimTeX to your liking. Users should read the documentation to
114119
learn the various configuration possibilities, but the below is a simple
115120
overview of some of the main aspects.
116121

117-
**PLEASE don't just copy this without reading the comments!**
122+
> [!CAUTION]
123+
>
124+
> **PLEASE** don't just copy this without reading the comments!
118125
119126
```vim
120127
" This is necessary for VimTeX to load properly. The "indent" is optional.
@@ -147,10 +154,6 @@ let g:vimtex_compiler_method = 'latexrun'
147154
let maplocalleader = ","
148155
```
149156

150-
**Note**: If the compiler or the viewer doesn't start properly, one may
151-
type `<localleader>li` to view the system commands that were executed to
152-
start them. To inspect the compiler output, use `<localleader>lo`.
153-
154157
## Quick Start
155158

156159
The following video shows how to use VimTeX's main features (credits:
@@ -163,6 +166,12 @@ basic functions.
163166

164167
https://user-images.githubusercontent.com/66584581/119213849-1b7d4080-ba77-11eb-8a31-7ff7b9a4a020.mp4
165168

169+
> [!TIP]
170+
>
171+
> If the compiler or the viewer doesn't start properly, one may type
172+
> `<localleader>li` to view the system commands that were executed to start
173+
> them. To inspect the compiler output, use `<localleader>lo`.
174+
166175
### Tutorial
167176

168177
Both new and experienced users are encouraged to read the excellent guide by

0 commit comments

Comments
 (0)