Add docs about sensible

This commit is contained in:
Adam Stankiewicz
2020-10-19 02:34:23 +02:00
parent 233a817f05
commit 71d9a2db9f

View File

@@ -8,11 +8,10 @@ A collection of language packs for Vim.
- It **won't affect your startup time**, as scripts are loaded only on demand\*. - It **won't affect your startup time**, as scripts are loaded only on demand\*.
- It **installs and updates 120+ times faster** than the <!--Package Count-->598<!--/Package Count--> packages it consists of. - It **installs and updates 120+ times faster** than the <!--Package Count-->598<!--/Package Count--> packages it consists of.
- It is more secure because scripts loaded for all extensions are generated by vim-polyglot (ftdetect). - It is also more secure (scripts loaded for every filetype are generated by vim-polyglot)
- Solid syntax and indentation support (other features skipped). Only the best language packs. - Best syntax and indentation support (no other features). Hand-selected language packs.
- All unnecessary files are ignored (like enormous documentation from php support). - Automatically detects indentation (includes fixed and performance-optimized version of [vim-sleuth](https://github.com/tpope/vim-sleuth), can be disabled)
- Automatically detect indentation (includes performance-optimized version of [vim-sleuth](https://github.com/tpope/vim-sleuth)) - Includes defaults from [vim-sensible](https://github.com/tpope/vim-sensible), which are usually necessary for editing in any language (can be disabled)
- Each build is tested by automated vimrunner script on CI. See `spec` directory.
\*To be completely honest, optimized `ftdetect` script takes around `10ms` to load. \*To be completely honest, optimized `ftdetect` script takes around `10ms` to load.
@@ -226,12 +225,23 @@ let g:polyglot_disabled = ['markdown.plugin']
Please note that disabling a language won't make in your vim startup any faster / slower (only for specific this specific filetype). All plugins are lazily loaded only when they are really needed. Please note that disabling a language won't make in your vim startup any faster / slower (only for specific this specific filetype). All plugins are lazily loaded only when they are really needed.
## Autoindent
Vim Polyglot tries to automatically detect indentation settings (just like vim-sleuth). If this feature is not working for you for some reason, please file an issue and disable it temporarily with: Vim Polyglot tries to automatically detect indentation settings (just like vim-sleuth). If this feature is not working for you for some reason, please file an issue and disable it temporarily with:
```vim ```vim
let g:polyglot_disabled = ['autoindent'] let g:polyglot_disabled = ['autoindent']
``` ```
## Default settings
Vim Polyglot includes vim-sensible plugin, which is usually necessary for editing any language. This can be disabled with:
```vim
let g:polyglot_disabled = ['sensible']
```
## Contributing ## Contributing
Language packs are periodically updated using automated `scripts/build` script. Language packs are periodically updated using automated `scripts/build` script.