VimPlug/python-syntax
1
0
Fork 0
mirror of https://github.com/vim-python/python-syntax.git synced 2025-12-07 21:24:52 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

README: Convert to markdown

Browse Source
This commit is contained in:
nfnty
2017-02-17 06:52:34 +01:00
parent aaa002e48d
commit 91430a49b6
3 changed files with 140 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
README.md Normal file
View File

@@ -0,0 +1,78 @@
Python syntax highlighting for Vim
=========================================
This is an enhanced version of the original Vim 6.1 Python syntax highlighting
`python.vim` by Neil Schemenauer.
Features
--------
* Added support for Python 3 syntax highlighting
* Added commands `Python2Syntax` and `Python3Syntax` allowing to easily switch
between Python 2 and Python 3.
* Updated string highlighting
* Enhanced special symbols highlighting inside strings
* Enhanced highlighting of numeric constants
* Added optional highlighting for %-formatting inside strings
* Added highlighting for magic comments: source code encoding and
shebangs (`#!`)
* Added highlighting for new exceptions and builtins
* Added highlighting for doctests
* Added highlighting for new `@decorator` syntax introduced in Python 2.4a2
* Added highlighting for the following errors:
* Invalid symbols in source file
* Mixing spaces and tabs
* Invalid numeric constants
* Invalid %-formatting inside strings
* Invalid variable names
* Trailing spaces (Enabled with `g:python_highlight_space_errors`)
Folding is done by the plugin [SimpylFold](https://github.com/tmhedberg/SimpylFold).
How to install
--------------
Use one of the following plugin managers:
* [dein](https://github.com/Shougo/dein.vim)
* [vim-plug](https://github.com/junegunn/vim-plug)
* [vundle](https://github.com/VundleVim/Vundle.vim)
* [pathogen](https://github.com/tpope/vim-pathogen)
Configuration
-------------
### Option variables
Set variable to `1` to enable or `0` to disable.
For example to enable all syntax highlighting features you can add the
following command to your `~/.config/nvim/init.vim` or `~/.vimrc`:
```vim
let g:python_highlight_all = 1
```
| Variable | Description | Default |
| --------------------------------------------- | -------------------------------------------------------------- | ------- |
| `g:python_version_2` | Python 2 mode | `0` |
| `b:python_version_2` | Python 2 mode (buffer local) | `0` |
| `g:python_highlight_builtins` | Highlight builtin functions and objects | `0` |
| `g:python_highlight_builtins` | Highlight builtin functions and objects | `0` |
| `g:python_highlight_builtin_objs` | Highlight builtin objects only | `0` |
| `g:python_highlight_builtin_funcs` | Highlight builtin functions only | `0` |
| `g:python_highlight_exceptions` | Highlight standard exceptions | `0` |
| `g:python_highlight_string_formatting` | Highlight `%` string formatting | `0` |
| `g:python_highlight_string_format` | Highlight syntax of `str.format` syntax | `0` |
| `g:python_highlight_string_templates` | Highlight syntax of `string.Template` | `0` |
| `g:python_highlight_indent_errors` | Highlight indentation errors | `0` |
| `g:python_highlight_space_errors` | Highlight trailing spaces | `0` |
| `g:python_highlight_doctests` | Highlight doc-tests | `0` |
| `g:python_highlight_all` | Enable all highlight options above, except for previously set. | `0` |
| `g:python_highlight_file_headers_as_comments` | Highlight shebang and coding headers as comments | `0` |
| `g:python_slow_sync` | Disable for slow machines | `1` |
### Commands
| Command | Description |
| --------------- | ------------------ |
| `Python2Syntax` | Switch to Python 2 |
| `Python3Syntax` | Switch to Python 3 |