Skip to content

Commit

Permalink
Add some initial vim help documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jparise committed Sep 3, 2017
1 parent 4e5224b commit b7dc054
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
31 changes: 31 additions & 0 deletions doc/graphql.txt
Original file line number Diff line number Diff line change
@@ -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:

0 comments on commit b7dc054

Please sign in to comment.