38234a1d3c
HTML documentation should be built with sphinx. This enables easy
integration with Read The Docs [1]. It can also be generated manually by
running:
make -C docs html
A man page can be generated by running:
make -C docs man
[1]: http://yamllint.readthedocs.org/
41 lines
1.0 KiB
ReStructuredText
41 lines
1.0 KiB
ReStructuredText
Integration with text editors
|
|
=============================
|
|
|
|
Most text editors support syntax checking and highlighting, to visually report
|
|
syntax errors and warnings to the user. yamllint can be used to syntax-check
|
|
YAML source, but a bit of configuration is required depending on your favorite
|
|
text editor.
|
|
|
|
Vim
|
|
---
|
|
|
|
Assuming that the `syntastic <https://github.com/scrooloose/syntastic>`_ plugin
|
|
is installed, add to your ``.vimrc``:
|
|
|
|
::
|
|
|
|
TODO
|
|
|
|
Neovim
|
|
------
|
|
|
|
Assuming that the `neomake <https://github.com/benekastah/neomake>`_ plugin is
|
|
installed, add to your ``.config/nvim/init.vim``:
|
|
|
|
::
|
|
|
|
if executable('yamllint')
|
|
let g:neomake_yaml_yamllint_maker = {
|
|
\ 'args': ['-f', 'parsable'],
|
|
\ 'errorformat': '%E%f:%l:%c: [error] %m,%W%f:%l:%c: [warning] %m' }
|
|
let g:neomake_yaml_enabled_makers = ['yamllint']
|
|
endif
|
|
|
|
Other text editors
|
|
------------------
|
|
|
|
.. rubric:: Help wanted!
|
|
|
|
Your favorite text editor is not listed here? Help us improve by adding a
|
|
section (by opening a pull-request or issue on GitHub).
|