summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAdam Stankiewicz <sheerun@sher.pl>2020-08-25 14:03:03 +0200
committerAdam Stankiewicz <sheerun@sher.pl>2020-08-25 14:03:03 +0200
commite47af23f64e4c02ab85080e94c23e57b3f66ecda (patch)
treeb02a2ea865faa46501da7480e11f38a2c0661b01 /doc
parent8f5134aef8c4162235892d87407275f447e54e40 (diff)
downloadvim-polyglot-e47af23f64e4c02ab85080e94c23e57b3f66ecda.tar.gz
vim-polyglot-e47af23f64e4c02ab85080e94c23e57b3f66ecda.zip
Cleanup ftdetect
Diffstat (limited to 'doc')
-rw-r--r--doc/graphql.txt55
-rw-r--r--doc/vim-jsx-pretty-doc.txt128
-rw-r--r--doc/vim-polyglot.txt25
3 files changed, 183 insertions, 25 deletions
diff --git a/doc/graphql.txt b/doc/graphql.txt
new file mode 100644
index 00000000..3f41deaa
--- /dev/null
+++ b/doc/graphql.txt
@@ -0,0 +1,55 @@
+if !exists('g:polyglot_disabled') || index(g:polyglot_disabled, 'graphql') == -1
+
+*graphql.txt* GraphQL plug-in for Vim *graphql*
+
+CONTENTS *graphql-contents*
+
+1. Introduction |graphql-intro|
+2. JavaScript Support |graphql-javascript|
+3. TypeScript Support |graphql-typescript|
+
+
+INTRODUCTION *graphql-intro*
+
+This plugin provides GraphQL (http://graphql.org/) file detection, syntax
+highlighting, and indentation.
+
+
+JAVASCRIPT *graphql-javascript*
+
+GraphQL syntax support in ES2015 template literals is provided. It works "out
+of the box" with Vim 8.2's JavaScript support. The extended syntax provided by
+the vim-javascript (https://github.com/pangloss/vim-javascript) plugin is also
+supported.
+
+ *graphql-javascript-options*
+
+ *g:graphql_javascript_tags*
+|g:graphql_javascript_tags| list of strings
+
+ Default: `["gql", "graphql", "Relay.QL"]`
+
+ This variable lists the ES2015 template tag names that will be recognized as
+ containing GraphQL template literal strings.
+
+
+TYPESCRIPT *graphql-typescript*
+
+Like |graphql-javascript|, GraphQL syntax support in ES2015 template literals
+is provided. It also works "out of the box" with Vim 8.2's TypeScript support,
+which is based on the yats (https://github.com/HerringtonDarkholme/yats.vim)
+plugin. For older versions, you can install yats directly.
+
+TypeScript syntax support also uses |graphql-javascript-options| to customize
+the list of recognized template tag names.
+
+REASONML *graphql-reasonml*
+
+GraphQL syntax support inside of ReasonML template strings using graphql-ppx
+is available when vim-reasonml (https://github.com/jordwalke/vim-reasonml) is
+also installed.
+
+------------------------------------------------------------------------------
+vim:tw=78:ft=help:norl:
+
+endif
diff --git a/doc/vim-jsx-pretty-doc.txt b/doc/vim-jsx-pretty-doc.txt
new file mode 100644
index 00000000..8ddc97f8
--- /dev/null
+++ b/doc/vim-jsx-pretty-doc.txt
@@ -0,0 +1,128 @@
+if !exists('g:polyglot_disabled') || !(index(g:polyglot_disabled, 'typescript') != -1 || index(g:polyglot_disabled, 'typescript') != -1 || index(g:polyglot_disabled, 'jsx') != -1)
+
+vim-jsx-pretty is syntax highlight for JSX (React.js).
+(https://github.com/MaxMEllon/vim-jsx-pretty)
+
+version 1.0.6
+Author: maxmellon<maxmellon1994@gmail.com>
+License: MIT
+
+About |vim-jsx-pretty-about|
+Usage |vim-jsx-pretty-usage|
+Install |vim-jsx-pretty-install|
+Config |vim-jsx-pretty-config|
+Detail |vim-jsx-pretty-detail|
+License |vim-jsx-pretty-license|
+Thanks |vim-jsx-retty-thanks|
+Inspiration |vim-jsx-pretty-inspiration|
+
+===============================================================================
+ABOUT *vim-jsx-pretty-about*
+
+*vim-jsx-pretty* is highlight and indentation JSX (React.js) syntax.
+
+Dependency Plugin:
+ - pangloss/vim-javascript
+
+===============================================================================
+USAGE *vim-jsx-pretty-usage*
+
+Just Install it.
+
+===============================================================================
+INSTALL *vim-jsx-pretty-install*
+
+If you used plugin manager `vim-plug`, As follows. >
+
+ Plug 'pangloss/vim-javascript' " dependency plugin
+ Plug 'maxmellon/vim-jsx-pretty'
+<
+===============================================================================
+CONFIG *vim-jsx-pretty-config*
+
+- config list
+>
+ | name | default | detail |
+ |---------------------------------------|---------|----------------------|
+ | g:vim_jsx_pretty_enable_jsx_highlight | 1 | jsx highlight flag |
+ | g:vim_jsx_pretty_colorful_config | 0 | colorful config flag |
+<
+
+- *g:vim_jsx_pretty_enable_jsx_highlight*
+
+If you set 'g:vim_jsx_pretty_enable_jsx_highlight', Disable jsx highlight.
+But highlight group is set to jsx syntax. So you should set manual
+highlight setting.
+
+ - Example: >
+
+ let g:vim_jsx_pretty_enable_jsx_highlight = 0
+
+ highlight def link jsxTag Function
+ highlight def link jsxTagName Function
+ highlight def link jsxString String
+ highlight def link jsxNameSpace Function
+ highlight def link jsxComment Error
+ highlight def link jsxAttrib Type
+ highlight def link jsxCloseTag Identifier
+ highlight def link jsxCloseString Identifier
+
+- *g:vim_jsx_pretty_colorful_config*
+
+If you set 'g:vim_jsx_pretty_colorful_config', Enable colorful config.
+
+===============================================================================
+DETAIL *vim-jsx-pretty-detail*
+
+- Syntax group list
+>
+ | name | match | | |
+ |--------------|--------------------|--------------|--------------------|
+ | jsxTag | `<tag id="sample">`| jsxjsxAttrib | `<tag id="sample">`|
+ | | `~~~~~~~~~~~~~~~~~`| | `_____~~__________`|
+ |--------------|--------------------|--------------|--------------------|
+ | jsxTagName | `<tag id="sample">`| jsxEqual | `<tag id="sample">`|
+ | | `_~~~_____________`| | `_______~_________`|
+ |--------------|--------------------|--------------|--------------------|
+ | jsxString | `<tag id="sample">`| jsxCloseTag | `</tag> | <tag />`|
+ | | `________~~~~~~~~_`| | `~~~~~~ | _____~~|
+ |--------------|--------------------|--------------|--------------------|
+
+===============================================================================
+LICENSE *vim-jsx-pretty-license*
+
+Copyright (c) 2016-2017 MaxMEllon
+MIT License
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+==============================================================================
+THANKS *vim-jsx-pretty-thanks*
+
+ - yuezk
+ - y0za
+ - cormacrelf
+
+===============================================================================
+INSPIREATION *vim-jsx-pretty-inspiration*
+
+ - vim-jsx
+ See: https://github.com/mxw/vim-jsx
+
+ vim:tw=78:ts=8:ft=help:norl:
+
+endif
diff --git a/doc/vim-polyglot.txt b/doc/vim-polyglot.txt
deleted file mode 100644
index 5a804998..00000000
--- a/doc/vim-polyglot.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-*vim-polyglot* Vim Polyglot
-
-===============================================================================
- *vim-polyglot-introduction*
-Introduction ~
-
-Vim Polyglot is a solid language pack for vim. No configuration needed.
-
-Please make sure you have `syntax on` in your `.vimrc`
-
-
-===============================================================================
-DISABLING LANGUAGE PACKS *vim-polyglot-disabled*
-
-
-Individual language packs can be disabled by setting `g:polyglot_disabled`:
-
->
- " ~/.vimrc, declare this variable before polyglot is loaded let
- g:polyglot_disabled = ['css']
-<
-
-Note that disabling languages won't make in general your vim startup any faster
-/ slower (only for specific file type). Vim-polyglot is selection of language
-plugins that are loaded only on demand.