Skip to content

Commit

Permalink
Add help doc
Browse files Browse the repository at this point in the history
  • Loading branch information
gpanders committed Jun 30, 2022
1 parent 73ee709 commit c7e637e
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions doc/editorconfig.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
*editorconfig.txt* EditorConfig plugin for Neovim

Author: Gregory Anders <[email protected]>
Repo: https://github.com/gpanders/editorconfig.nvim
License: GPL-3.0-or-later

INTRODUCTION *editorconfig*

editorconfig.nvim is an EditorConfig plugin for Neovim that automatically
finds and parses .editorconfig files and applies its settings to each buffer.

The following properties are supported:

*editorconfig_charset*
charset One of "utf-8", "utf-8-bom", "latin1", "utf-16be", or
"utf-16le". Sets the 'fileencoding' and 'bomb'
options.

*editorconfig_end_of_line*
end_of_line One of "lf", "crlf", or "cr". These correspond to
setting 'fileformat' to "unix", "dos", or "mac",
respectively.

*editorconfig_indent_style*
indent_style One of "tab" or "space". Sets the 'expandtab' option.

*editorconfig_indent_size*
indent_size A number indicating the size of a single indent.
Alternatively, use the value "tab" to use the value of
the tab_width property. Sets the 'shiftwidth' and
'softtabstop'.

*editorconfig_insert_final_newline*
insert_final_newline "true" or "false" to ensure the file always has a
trailing newline as its last byte. Sets the
'fixendofline' and 'endofline' options.

*editorconfig_max_line_length*
max_line_length A number indicating the maximum length of a single
line. Sets the 'textwidth' option.

*editorconfig_tab_width*
tab_width The display size of a single tab character. Sets the
'tabstop' option.

*editorconfig_trim_trailing_whitespace*
trim_trailing_whitespace
When "true", trailing whitespace is automatically
removed when the buffer is written.


vim:tw=78:ts=8:noet:ft=help:norl:

0 comments on commit c7e637e

Please sign in to comment.