diff --git a/README.md b/README.md index f19f535..2b42f9c 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,11 @@ detection, syntax highlighting, and indentation. It currently targets the 1. `cd ~/.vim/bundle` 2. `git clone https://github.com/jparise/vim-graphql.git` +## JavaScript Support + +When the [vim-javascript](https://github.com/pangloss/vim-javascript) plugin is +installed, GraphQL syntax support in ES6 tagged template literals is enabled. + ## Testing The test suite uses [Vader.vim][]. To run all of the tests from the command diff --git a/doc/graphql.txt b/doc/graphql.txt new file mode 100644 index 0000000..cf8b538 --- /dev/null +++ b/doc/graphql.txt @@ -0,0 +1,31 @@ +*graphql.txt* GraphQL plug-in for Vim *graphql* + +CONTENTS *graphql-contents* + +1. Introduction |graphql-intro| +1. JavaScript Support |graphql-javascript| + + +INTRODUCTION *graphql-intro* + +This plugin provides GraphQL (http://graphql.org/) file detection, syntax +highlighting, and indentation. + + +JAVASCRIPT *graphql-javascript* + +When the vim-javascript (https://github.com/pangloss/vim-javascript) plugin is +installed, GraphQL syntax support in ES6 tagged template literals is enabled. + + *graphql-javascript-options* + + *g:graphql_javascript_tags* +|g:graphql_javascript_tags| list of strings + + Default: `['gql', 'graphql', 'Relay.QL']` + + This variable lists the JavaScript/ES6 template literal tag names that will + be recognized as containing GraphQL template strings. + +------------------------------------------------------------------------------ +vim:tw=78:ft=help:norl: