Skip to content

Commit b7dc054

Browse files
committed
Add some initial vim help documentation
1 parent 4e5224b commit b7dc054

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ detection, syntax highlighting, and indentation. It currently targets the
2323
1. `cd ~/.vim/bundle`
2424
2. `git clone https://github.com/jparise/vim-graphql.git`
2525

26+
## JavaScript Support
27+
28+
When the [vim-javascript](https://github.com/pangloss/vim-javascript) plugin is
29+
installed, GraphQL syntax support in ES6 tagged template literals is enabled.
30+
2631
## Testing
2732

2833
The test suite uses [Vader.vim][]. To run all of the tests from the command

doc/graphql.txt

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
*graphql.txt* GraphQL plug-in for Vim *graphql*
2+
3+
CONTENTS *graphql-contents*
4+
5+
1. Introduction |graphql-intro|
6+
1. JavaScript Support |graphql-javascript|
7+
8+
9+
INTRODUCTION *graphql-intro*
10+
11+
This plugin provides GraphQL (http://graphql.org/) file detection, syntax
12+
highlighting, and indentation.
13+
14+
15+
JAVASCRIPT *graphql-javascript*
16+
17+
When the vim-javascript (https://github.com/pangloss/vim-javascript) plugin is
18+
installed, GraphQL syntax support in ES6 tagged template literals is enabled.
19+
20+
*graphql-javascript-options*
21+
22+
*g:graphql_javascript_tags*
23+
|g:graphql_javascript_tags| list of strings
24+
25+
Default: `['gql', 'graphql', 'Relay.QL']`
26+
27+
This variable lists the JavaScript/ES6 template literal tag names that will
28+
be recognized as containing GraphQL template strings.
29+
30+
------------------------------------------------------------------------------
31+
vim:tw=78:ft=help:norl:

0 commit comments

Comments
 (0)